TamaDB API (0.7.1)

Download OpenAPI specification:

License: Apache-2.0

Document-centric transmission cache — REST API reference.

TamaDB is a document-centric transmission cache for smart-endpoints / dumb-pipes architectures: a JSON document-oriented cache engine that validates, versions, and delivers producer data to consumers. This is the complete REST API reference for Increment 1.

This document is the single source of truth for the TamaDB HTTP surface. It is linted in CI (redocly lint) and rendered to the published API Reference by Redoc, so the docs cannot silently drift from the contract.

Conventions

  • All endpoints exchange application/json, except the ingestion endpoints, whose request body is the bare JSON document (see Ingestion).
  • Every endpoint lives under the /api/v1 prefix except GET /health.
  • There is no authentication in Increment 1.
  • Path parameters are shown as {paramName}.

Upsert semantics

TamaDB documents are upserted — there is no separate create vs update. The first ingest of a given identity creates the document (HTTP 201); a subsequent ingest of the same identity merges into it (HTTP 200), preserving absent leaves and incrementing the version number.

Document identity and identityKind

A document's identity (D-Id) is derived from one or more payload fields annotated with the identityKind keyword in the schema. Identity is scoped to (Document_Type, D-Id).

identityKind is a custom (vendor) JSON Schema keyword that TamaDB reads from registered schemas to extract the D-Id. It is attached to scalar leaf properties and takes one of two values:

  • primary-key — a field that contributes to the document's own identity.
  • parent-key — a field that contributes a parent/ancestor identity segment.

It may be annotated at any object-nesting depth (universal nested-path identity, since 0.2.0); the field is addressed by its root-to-leaf Identity_Path. Arrays are never traversed (atomic in Increment 1) and the annotated value must be a scalar. The keyword is ignored by schema validation (Ajv runs with strict: false) and consumed only by the D-Id Extractor. It is therefore a property of the posted schema, not a request/response field. See the Schemas tag for how to register a schema carrying identityKind.

A composed (multi-field) D-Id is expressed in a URL by joining its parts with the : delimiter. Each part is percent-encoded (via encodeURIComponent, and : is additionally encoded as %3A) so that a part value may itself contain the delimiter, /, or other reserved characters without corrupting the part boundaries. In response bodies, a single-key dId is a string and a composed dId is an array of strings.

TTL & expiry (sliding window)

A cached document's TTL is a sliding window anchored to its last update (lastUpdateTime + effectiveTTL), re-armed on every store (create or merge) — since 0.4.0. Reads and value-search listings never re-arm the window. A continuously-updated document therefore persists indefinitely by design (the producer owns the cache lifetime). A store targeting an expired-but-salvageable document revives it.

The TTL hierarchy is Document > Document_Type > Instance (most specific wins). TamaDB-Expire-At is an absolute, non-sliding, non-salvageable deadline that overrides TTL.

Document metadata and timestamps

Every store appends a timestamp entry to the stored document carrying a Request_Timestamp (t1, request receipt — the versioning / history / TTL-anchor time) and a Commit_Timestamp (t1+m, write-completion time). As of 0.4.1 the Commit_Timestamp is populated on every stored entry (it was previously always empty).

These timestamps are document metadata, not part of the default retrieval response: GET /api/v1/documents/{documentType}/{dId} returns the stored document's own fields (the producer payload plus any enrichment), and the mode / path options only select which data fields are returned — they never emit the metadata. Webhook deliveries do not carry it either: the delivery body (see the webhook operation) is the document's content — wrapped in delivery context only if the subscription asks for the envelope format, with the context otherwise carried in TamaDB-* headers — and never the stored timestamps. Delivering document metadata such as the Commit_Timestamp to subscribers is planned for a later increment and is not implemented yet; the includeMetadata subscription option is accepted but currently has no effect.

Error responses

All errors share a consistent shape (code + message, with optional reason, context, quarantineRef, warning). See the Error schema and the error-code → HTTP-status table in httpStatusForCode.

Health

Liveness / readiness probe, build info, and service-discovery metadata.

Liveness / readiness probe

Returns ok plus build info (version, commit) and the active storage mode and log level. This is the only endpoint not under /api/v1.

Responses

Response Schema: application/json
status
required
any

Always ok when the instance is serving.

Value: "ok"
version
required
string

Resolved from package.json at runtime.

commit
required
string

Build commit; unknown when no build-info is present.

storageMode
required
string (StorageMode)
Enum: "auto" "memory" "disk" "hybrid"

The storage strategy governing where documents are held:

  • auto — the engine selects a strategy automatically.
  • memory — in-memory only (fastest; not durable across restart).
  • disk — persisted to disk (durable; nothing buffered in memory).
  • hybrid — in-memory working set with disk persistence.

/health reports the active mode; GET/PUT /api/v1/config/storage-strategy reads and changes it at runtime.

logLevel
required
string (LogLevel)
Enum: "debug" "info" "warn" "error" "silent"

The active log verbosity, most to least verbose:

  • debug — everything (default).
  • info — informational events and above.
  • warn — warnings and errors only.
  • error — errors only.
  • silent — logging disabled.

Response samples

Content type
application/json
{
  • "status": "ok",
  • "version": "0.7.1",
  • "commit": "5e1efe539201",
  • "storageMode": "auto",
  • "logLevel": "debug"
}

Service information (discovery / metadata)

Service-discovery metadata — stable identity, version/build fingerprint, environment, operational status, and where to find the docs — for humans and client tooling. Distinct from /health, which is the lightweight liveness/readiness probe. All values are resolved at runtime (from package.json / build-info) or from configuration (TAMADB_ENV, TAMADB_DOCS_URL, TAMADB_OPENAPI_URL), so a self-hosted instance can report its own environment and doc locations.

Responses

Response Schema: application/json
name
required
string

Service/application name (from package.json).

description
string

One-line service description (from package.json).

version
required
string

Current semantic version (from package.json), e.g. 0.7.1.

commit
required
string

Build commit; unknown when no build-info is present.

apiVersion
required
string

The URL contract version segment, e.g. v1 (the /api/v1 prefix).

environment
required
string

Deployment stage label (configurable via TAMADB_ENV). Increment 1 defaults to increment-1 (PoC — no production deployment).

status
required
string

Operational state.

documentation
required
string <uri>

URL of the human-facing API reference (Redoc).

openapi
required
string <uri>

URL of the machine-readable OpenAPI document, for tooling discovery.

startedAt
required
string <date-time>

Process start time (ISO 8601), for a rough uptime signal.

Response samples

Content type
application/json
{
  • "name": "tamadb",
  • "description": "TamaDB — a document-centric transmission cache for smart-endpoints/dumb-pipes architectures; a JSON document-oriented cache engine for producer/consumer data exchange (Increment 1).",
  • "version": "0.7.1",
  • "commit": "5e1efe539201",
  • "apiVersion": "v1",
  • "environment": "increment-1",
  • "status": "operational",
  • "startedAt": "2026-10-17T12:49:37.086Z"
}

Admin

Operational admin endpoints (e.g. graceful shutdown).

Trigger a graceful shutdown

Responds 200 immediately, then (asynchronously) drains in-memory documents to disk, persists all component state, closes the HTTP server, and exits the process. The recommended cross-platform way to stop TamaDB (SIGTERM can be unreliable on some platforms). After the response, the server stops accepting new requests.

Responses

Response Schema: application/json
status
required
any
Value: "shutting-down"

Response samples

Content type
application/json
{
  • "status": "shutting-down"
}

Ingestion

Document ingestion. The request body is the bare JSON document; per-request instructions travel as reserved TamaDB-* Control_Headers.

Ingest a document (default channel)

Ingest a document for {documentType} via the default channel. The request body is the bare JSON document (a JSON object), not a wrapper. Per-request instructions are supplied as reserved TamaDB-* Control_Headers (see parameters).

Returns 201 when the document is created and 200 when an existing document is merged (upsert). On a payload-level rejection the response carries an Error with an optional quarantineRef.

Each successful store records a timestamp entry on the stored document with a populated Commit_Timestamp (write-completion time; see Document metadata and timestamps). This metadata is not returned in the ingest response — the response body is the IngestResult below.

path Parameters
documentType
required
string

The Document_Type name.

header Parameters
TamaDB-Version
integer >= 1
Example: 2

Expected version number for optimistic concurrency — a positive integer (≥ 1). A mismatch is rejected with VERSION_CONFLICT.

integer or "infinite" (string)
Example: 3600

Document-level TTL — a non-negative integer number of seconds, or the literal infinite.

TamaDB-Expire-At
string <date-time>
Example: 2026-07-17T18:00:00Z

Absolute expiry instant as an ISO-8601 / RFC 3339 date-time that must carry an explicit timezone (a trailing Z or a ±HH:MM offset). A timezone-less value is rejected with INVALID_CONTROL_HEADER.

TamaDB-Schema
string non-empty
Example: temperature-sensor-v1

Explicit Storage_Schema override (a non-empty schema ref). This is the only way to override the schema per request — it is header-only.

Request Body schema: application/json
required

The bare JSON document — a JSON object, with no wrapper. A malformed body becomes a PARSE_ERROR and is quarantined per policy; a valid-JSON non-object is likewise a PARSE_ERROR.

property name*
additional property
any

Responses

Response Schema: application/json
required
string or Array of strings (DId)
versionNo
required
integer
created
required
boolean

True on create (201), false on merge (200).

object
Response Schema: application/json
required
string or Array of strings (DId)
versionNo
required
integer
created
required
boolean

True on create (201), false on merge (200).

object

Request samples

Content type
application/json
Example

A complete reading sent to the default channel. The D-Id is extracted from the sensorId field (the primary-key).

{
  • "sensorId": "LIVING-ROOM-01",
  • "location": "Living Room",
  • "temperature": 21.5,
  • "timestamp": "2026-07-17T10:05:00Z"
}

Response samples

Content type
application/json
{
  • "dId": "GARAGE-TEMP-01",
  • "versionNo": 2,
  • "created": false
}

Ingest a document via a named channel

As POST /api/v1/ingest/{documentType}, but routes through the named {channelId} so channel enrichment and the channel schema apply.

path Parameters
documentType
required
string

The Document_Type name.

channelId
required
string

The channel identifier.

header Parameters
TamaDB-Version
integer >= 1
Example: 2

Expected version number for optimistic concurrency — a positive integer (≥ 1). A mismatch is rejected with VERSION_CONFLICT.

integer or "infinite" (string)
Example: 3600

Document-level TTL — a non-negative integer number of seconds, or the literal infinite.

TamaDB-Expire-At
string <date-time>
Example: 2026-07-17T18:00:00Z

Absolute expiry instant as an ISO-8601 / RFC 3339 date-time that must carry an explicit timezone (a trailing Z or a ±HH:MM offset). A timezone-less value is rejected with INVALID_CONTROL_HEADER.

TamaDB-Schema
string non-empty
Example: temperature-sensor-v1

Explicit Storage_Schema override (a non-empty schema ref). This is the only way to override the schema per request — it is header-only.

Request Body schema: application/json
required

The bare JSON document — a JSON object, with no wrapper. A malformed body becomes a PARSE_ERROR and is quarantined per policy; a valid-JSON non-object is likewise a PARSE_ERROR.

property name*
additional property
any

Responses

Response Schema: application/json
required
string or Array of strings (DId)
versionNo
required
integer
created
required
boolean

True on create (201), false on merge (200).

object
Response Schema: application/json
required
string or Array of strings (DId)
versionNo
required
integer
created
required
boolean

True on create (201), false on merge (200).

object

Request samples

Content type
application/json
Example

A complete reading sent to the default channel. The D-Id is extracted from the sensorId field (the primary-key).

{
  • "sensorId": "LIVING-ROOM-01",
  • "location": "Living Room",
  • "temperature": 21.5,
  • "timestamp": "2026-07-17T10:05:00Z"
}

Response samples

Content type
application/json
{
  • "dId": "GARAGE-TEMP-01",
  • "versionNo": 2,
  • "created": false
}

Documents

Retrieve, delete, value-search, and set per-document TTL.

Retrieve a document (or glob-match)

Retrieve a single document by {documentType} and {dId}.

If {dId} contains glob characters (* or ?), the endpoint switches to glob retrieval and returns a { matches, count } collection instead of a single document.

A TTL-expired but salvageable document is served in place as a Best-Effort Read (visibility only — the read does not re-arm the TTL, restore the document, or clear its soft-delete state).

path Parameters
documentType
required
string

The Document_Type name.

dId
required
string
Examples:
  • GARAGE-TEMP-01 - Single-key D-Id
  • ORD-1001:L-1 - Composed (multi-field) D-Id
  • * - Glob (match all)

The document identity. A composed D-Id joins its percent-encoded parts with the : delimiter (e.g. ORD-1001:L-1). Glob characters (*, ?) switch GET to glob retrieval.

query Parameters
path
string

Field/sub-path projection (dotted path into the document).

mode
string
Default: "full"
Enum: "closed" "open" "full"

Projection model controlling which fields the returned document carries (default full):

  • closed — only fields defined in the applicable schema.
  • open — schema fields plus any extension fields present.
  • full — the entire stored document, unfiltered.

Responses

Response Schema: application/json
property name*
additional property
any

Response samples

Content type
application/json
Example
{
  • "sensorId": "GARAGE-TEMP-01",
  • "location": "Garage",
  • "temperature": 19.1,
  • "timestamp": "2026-07-17T10:10:00Z"
}

Explicitly soft-delete a document

Soft-deletes the document with reason explicit. An explicit delete is permanent (non-salvageable) and is not revived by a later store.

path Parameters
documentType
required
string

The Document_Type name.

dId
required
string
Examples:
  • GARAGE-TEMP-01 - Single-key D-Id
  • ORD-1001:L-1 - Composed (multi-field) D-Id
  • * - Glob (match all)

The document identity. A composed D-Id joins its percent-encoded parts with the : delimiter (e.g. ORD-1001:L-1). Glob characters (*, ?) switch GET to glob retrieval.

Responses

Response Schema: application/json
deleted
required
any
Value: true
subscriptionsCancelled
integer >= 1

The number of D-Id-scoped subscriptions on this document that were auto-cancelled by the explicit delete. Present only when ≥1 subscription was cancelled; omitted when none were. Document_Type-scoped subscriptions are never cancelled by a document delete.

Response samples

Content type
application/json
Example
{
  • "deleted": true
}

Value-based search within a Document_Type

Returns all documents of {documentType} whose field equals value.

includeExpired controls whether TTL-driven salvageable soft-deletes are surfaced. It defaults to true when omitted. Search is visibility-only: it never alters the TTL clock or persists a state change. A document listed by search is not guaranteed retrievable by a later point lookup.

path Parameters
documentType
required
string

The Document_Type name.

Request Body schema: application/json
required
field
required
string

The field name (or path) to match on.

value
required
any

The value to match (any JSON type).

includeExpired
boolean
Default: true

Whether TTL-driven, salvageable soft-deleted documents are surfaced in the results (visibility only — never alters the TTL clock or persists a state change):

  • true (default) — include salvageable TTL-expired documents, consistent with point-lookup Best-Effort Read.
  • false — return only live (non-expired) documents.

Non-salvageable soft-deletes (explicit, system_override, absolute_expired, and TTL = 0) are never surfaced either way.

Responses

Response Schema: application/json
required
Array of objects (Document)
count
required
integer

Request samples

Content type
application/json
{
  • "field": "location",
  • "value": "Garage"
}

Response samples

Content type
application/json
{
  • "matches": [
    ],
  • "count": 1
}

Set a per-document (most-specific) TTL

Sets the document-level TTL — the most specific rung of the TTL hierarchy (Document > Document_Type > Instance). A TTL below the configured floor is raised to the floor and reported via warning.

path Parameters
documentType
required
string

The Document_Type name.

dId
required
string
Examples:
  • GARAGE-TEMP-01 - Single-key D-Id
  • ORD-1001:L-1 - Composed (multi-field) D-Id
  • * - Glob (match all)

The document identity. A composed D-Id joins its percent-encoded parts with the : delimiter (e.g. ORD-1001:L-1). Glob characters (*, ?) switch GET to glob retrieval.

Request Body schema: application/json
required
required
integer or "infinite" (string) (Ttl)

Responses

Response Schema: application/json
documentType
required
string
dId
required
string
required
integer or "infinite" (string) (Ttl)
object (TtlWarning)

Emitted when a requested TTL was raised to the configured floor.

Request samples

Content type
application/json
{
  • "ttl": 7200
}

Response samples

Content type
application/json
{
  • "documentType": "temperature-readings",
  • "dId": "GARAGE-TEMP-01",
  • "ttl": 7200
}

Schemas

JSON Schema repository — register, retrieve, version, lifecycle.

Register a schema

Register a JSON Schema under a unique ref. The schema may carry identityKind annotations (primary-key / parent-key) on scalar leaf properties to drive D-Id extraction; those annotations are ignored by validation. An optional dIdDefinition provides a metadata fallback for third-party schemas that cannot be annotated inline.

Request Body schema: application/json
required
ref
required
string

Unique schema reference.

required
object (JsonSchema)

A JSON Schema document. May carry the TamaDB-specific identityKind keyword (primary-key / parent-key) on scalar leaf properties; that keyword is ignored by validation and read only by the D-Id Extractor.

object (DIdDefinition)

Metadata fallback D-Id definition for schemas not annotated inline.

Responses

Response Schema: application/json
ref
required
string
version
required
integer

Request samples

Content type
application/json
{
  • "ref": "temperature-sensor-v1",
  • "schema": {
    }
}

Response samples

Content type
application/json
{
  • "ref": "temperature-sensor-v1",
  • "version": 1
}

List all registered schemas

Returns every registered schema entry. Symmetric with GET /api/v1/config/document-types. Added in 0.5.0.

Responses

Response Schema: application/json
Array
ref
required
string
required
object (JsonSchema)

A JSON Schema document. May carry the TamaDB-specific identityKind keyword (primary-key / parent-key) on scalar leaf properties; that keyword is ignored by validation and read only by the D-Id Extractor.

version
required
integer
required
Array of objects (SchemaVersion)
lifecycle
required
string
Enum: "active" "decommissioned"

Schema lifecycle state:

  • active — usable for Document_Type/channel assignment and validation.
  • decommissioned — retired; cannot be assigned to new Document_Types (reactivate to restore).
object (DIdDefinition)

Metadata fallback D-Id definition for schemas not annotated inline.

createdAt
required
string <date-time>
updatedAt
required
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a schema entry

path Parameters
schemaRef
required
string

The schema reference.

Responses

Response Schema: application/json
ref
required
string
required
object (JsonSchema)

A JSON Schema document. May carry the TamaDB-specific identityKind keyword (primary-key / parent-key) on scalar leaf properties; that keyword is ignored by validation and read only by the D-Id Extractor.

version
required
integer
required
Array of objects (SchemaVersion)
lifecycle
required
string
Enum: "active" "decommissioned"

Schema lifecycle state:

  • active — usable for Document_Type/channel assignment and validation.
  • decommissioned — retired; cannot be assigned to new Document_Types (reactivate to restore).
object (DIdDefinition)

Metadata fallback D-Id definition for schemas not annotated inline.

createdAt
required
string <date-time>
updatedAt
required
string <date-time>

Response samples

Content type
application/json
{
  • "ref": "temperature-sensor-v1",
  • "schema": {
    },
  • "version": 1,
  • "versions": [
    ],
  • "lifecycle": "active",
  • "createdAt": "2026-07-17T09:00:00Z",
  • "updatedAt": "2026-07-17T09:00:00Z"
}

Update a schema (creates a new version)

path Parameters
schemaRef
required
string

The schema reference.

Request Body schema: application/json
required
required
object (JsonSchema)

A JSON Schema document. May carry the TamaDB-specific identityKind keyword (primary-key / parent-key) on scalar leaf properties; that keyword is ignored by validation and read only by the D-Id Extractor.

Responses

Response Schema: application/json
ref
required
string
version
required
integer

Request samples

Content type
application/json
{
  • "schema": {
    }
}

Response samples

Content type
application/json
{
  • "ref": "temperature-sensor-v1",
  • "version": 2
}

Decommission a schema

Rejected while the schema is the Master_Schema of an active Document_Type (MASTER_SCHEMA_ACTIVE).

path Parameters
schemaRef
required
string

The schema reference.

Responses

Response Schema: application/json
decommissioned
required
any
Value: true

Response samples

Content type
application/json
{
  • "decommissioned": true
}

Reactivate a decommissioned schema

path Parameters
schemaRef
required
string

The schema reference.

Responses

Response Schema: application/json
reactivated
required
any
Value: true

Response samples

Content type
application/json
{
  • "reactivated": true
}

List a schema's version history

path Parameters
schemaRef
required
string

The schema reference.

Responses

Response Schema: application/json
Array
version
required
integer
required
object (JsonSchema)

A JSON Schema document. May carry the TamaDB-specific identityKind keyword (primary-key / parent-key) on scalar leaf properties; that keyword is ignored by validation and read only by the D-Id Extractor.

timestamp
required
string <date-time>

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Document_Types

Document_Type registry and effective Document_Type TTL.

Register a Document_Type

Request Body schema: application/json
required
name
required
string
masterSchema
required
string

Ref of the registered Master_Schema.

model
required
string (DocumentModel)
Enum: "closed" "hybrid" "open"

The validation model for a Document_Type:

  • closed — DCM (Document_Closed_Model): strict validation; only fields defined in the Master_Schema are allowed (no extensions).
  • hybrid — HDOM (Hybrid_Document_Open_Model): Master_Schema validation is enforced, but documents may carry additional fields.
  • open — DOM (Document_Open_Model): no schema enforcement; any structure is accepted.
integer or "infinite" (string) (Ttl)

Responses

Response Schema: application/json
name
required
string
masterSchema
required
string
model
required
string (DocumentModel)
Enum: "closed" "hybrid" "open"

The validation model for a Document_Type:

  • closed — DCM (Document_Closed_Model): strict validation; only fields defined in the Master_Schema are allowed (no extensions).
  • hybrid — HDOM (Hybrid_Document_Open_Model): Master_Schema validation is enforced, but documents may carry additional fields.
  • open — DOM (Document_Open_Model): no schema enforcement; any structure is accepted.
integer or "infinite" (string) (Ttl)
channels
Array of strings

Channel IDs registered against this Document_Type.

createdAt
string <date-time>
updatedAt
string <date-time>

Request samples

Content type
application/json
{
  • "name": "temperature-readings",
  • "masterSchema": "temperature-sensor-v1",
  • "model": "closed",
  • "ttl": 3600
}

Response samples

Content type
application/json
{
  • "name": "temperature-readings",
  • "masterSchema": "temperature-sensor-v1",
  • "model": "closed",
  • "ttl": 3600,
  • "channels": [ ],
  • "createdAt": "2026-07-17T09:05:00Z",
  • "updatedAt": "2026-07-17T09:05:00Z"
}

List all Document_Types

Responses

Response Schema: application/json
Array
name
required
string
masterSchema
required
string
model
required
string (DocumentModel)
Enum: "closed" "hybrid" "open"

The validation model for a Document_Type:

  • closed — DCM (Document_Closed_Model): strict validation; only fields defined in the Master_Schema are allowed (no extensions).
  • hybrid — HDOM (Hybrid_Document_Open_Model): Master_Schema validation is enforced, but documents may carry additional fields.
  • open — DOM (Document_Open_Model): no schema enforcement; any structure is accepted.
integer or "infinite" (string) (Ttl)
channels
Array of strings

Channel IDs registered against this Document_Type.

createdAt
string <date-time>
updatedAt
string <date-time>

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a Document_Type

path Parameters
documentType
required
string

The Document_Type name.

Responses

Response Schema: application/json
name
required
string
masterSchema
required
string
model
required
string (DocumentModel)
Enum: "closed" "hybrid" "open"

The validation model for a Document_Type:

  • closed — DCM (Document_Closed_Model): strict validation; only fields defined in the Master_Schema are allowed (no extensions).
  • hybrid — HDOM (Hybrid_Document_Open_Model): Master_Schema validation is enforced, but documents may carry additional fields.
  • open — DOM (Document_Open_Model): no schema enforcement; any structure is accepted.
integer or "infinite" (string) (Ttl)
channels
Array of strings

Channel IDs registered against this Document_Type.

createdAt
string <date-time>
updatedAt
string <date-time>

Response samples

Content type
application/json
{
  • "name": "temperature-readings",
  • "masterSchema": "temperature-sensor-v1",
  • "model": "closed",
  • "ttl": 3600,
  • "channels": [
    ],
  • "createdAt": "2026-07-17T09:05:00Z",
  • "updatedAt": "2026-07-17T09:05:00Z"
}

Delete a Document_Type

Rejected while documents of that type exist (including soft-deleted ones) — DOCUMENTS_EXIST.

path Parameters
documentType
required
string

The Document_Type name.

Responses

Response Schema: application/json
deleted
required
any
Value: true

Response samples

Content type
application/json
{
  • "deleted": true
}

Set the Document_Type TTL

path Parameters
documentType
required
string

The Document_Type name.

Request Body schema: application/json
required
required
integer or "infinite" (string) (Ttl)

Responses

Response Schema: application/json
required
integer or "infinite" (string) (Ttl)
object (TtlWarning)

Emitted when a requested TTL was raised to the configured floor.

Request samples

Content type
application/json
{
  • "ttl": 7200
}

Response samples

Content type
application/json
{
  • "ttl": 7200
}

Get the effective Document_Type TTL

Returns the governing TTL the TtlManager actually consults for a type — the Document_Type TTL, or the instance TTL if none is configured for the type. Symmetric with GET /api/v1/config/ttl/instance.

path Parameters
documentType
required
string

The Document_Type name.

Responses

Response Schema: application/json
documentType
required
string
required
integer or "infinite" (string) (Ttl)

Response samples

Content type
application/json
{
  • "documentType": "temperature-readings",
  • "ttl": 3600
}

Channels

Ingestion channels and their enrichment bindings.

Register a channel

Request Body schema: application/json
required
channelId
required
string
documentType
required
string
channelSchema
string

Optional Channel_Schema ref.

initialStatus
string
Enum: "active" "inactive"

The channel's status at registration (default active):

  • active — accepts ingestion immediately.
  • inactive — registered but suspended; ingestion is rejected with CHANNEL_INACTIVE until activated.

Responses

Response Schema: application/json
channelId
required
string
documentType
required
string
channelSchema
string or null
Array of objects (EnrichmentBinding)
status
required
string
Enum: "active" "inactive" "blocked"

Channel status:

  • active — accepting ingestion.
  • inactive — operator-suspended; ingestion rejected with CHANNEL_INACTIVE.
  • blocked — system-suspended due to a schema-consistency failure; ingestion rejected with CHANNEL_BLOCKED. Set by TamaDB, not by the operator — this is why channel registration only accepts active/inactive as initialStatus, but a returned channel may report blocked.
endpoint
string

The ingest URL path for this channel.

Request samples

Content type
application/json
{
  • "channelId": "garage-sensor",
  • "documentType": "temperature-readings",
  • "channelSchema": "temperature-sensor-v1"
}

Response samples

Content type
application/json
{
  • "channelId": "garage-sensor",
  • "documentType": "temperature-readings",
  • "channelSchema": "temperature-sensor-v1",
  • "enrichmentBindings": [ ],
  • "status": "active",
  • "endpoint": "/api/v1/ingest/temperature-readings/garage-sensor"
}

List channels

query Parameters
documentType
string

Filter channels by Document_Type.

Responses

Response Schema: application/json
Array
channelId
required
string
documentType
required
string
channelSchema
string or null
Array of objects (EnrichmentBinding)
status
required
string
Enum: "active" "inactive" "blocked"

Channel status:

  • active — accepting ingestion.
  • inactive — operator-suspended; ingestion rejected with CHANNEL_INACTIVE.
  • blocked — system-suspended due to a schema-consistency failure; ingestion rejected with CHANNEL_BLOCKED. Set by TamaDB, not by the operator — this is why channel registration only accepts active/inactive as initialStatus, but a returned channel may report blocked.
endpoint
string

The ingest URL path for this channel.

Response samples

Content type
application/json
[
  • {
    }
]

Update a channel

path Parameters
channelId
required
string

The channel identifier.

Request Body schema: application/json
required
channelSchema
string or null

New Channel_Schema ref, or null to clear.

Responses

Response Schema: application/json
channelId
required
string
documentType
required
string
channelSchema
string or null
Array of objects (EnrichmentBinding)
status
required
string
Enum: "active" "inactive" "blocked"

Channel status:

  • active — accepting ingestion.
  • inactive — operator-suspended; ingestion rejected with CHANNEL_INACTIVE.
  • blocked — system-suspended due to a schema-consistency failure; ingestion rejected with CHANNEL_BLOCKED. Set by TamaDB, not by the operator — this is why channel registration only accepts active/inactive as initialStatus, but a returned channel may report blocked.
endpoint
string

The ingest URL path for this channel.

Request samples

Content type
application/json
{
  • "channelSchema": "temperature-sensor-v1"
}

Response samples

Content type
application/json
{
  • "channelId": "garage-sensor",
  • "documentType": "temperature-readings",
  • "channelSchema": "temperature-sensor-v1",
  • "enrichmentBindings": [ ],
  • "status": "active",
  • "endpoint": "/api/v1/ingest/temperature-readings/garage-sensor"
}

Delete a channel

path Parameters
channelId
required
string

The channel identifier.

Responses

Response Schema: application/json
deleted
required
any
Value: true

Response samples

Content type
application/json
{
  • "deleted": true
}

Activate a channel

path Parameters
channelId
required
string

The channel identifier.

Responses

Response Schema: application/json
channelId
required
string
status
required
any
Value: "active"

Response samples

Content type
application/json
{
  • "channelId": "garage-sensor",
  • "status": "active"
}

Deactivate a channel

path Parameters
channelId
required
string

The channel identifier.

Responses

Response Schema: application/json
channelId
required
string
status
required
any
Value: "inactive"

Response samples

Content type
application/json
{
  • "channelId": "garage-sensor",
  • "status": "inactive"
}

Register enrichment bindings for a channel

Each binding sets a static value at a field path during ingestion. dIdClassification reports whether any binding targets an identityKind-annotated field (foreign) or not (native).

path Parameters
channelId
required
string

The channel identifier.

Request Body schema: application/json
required
required
Array of objects (EnrichmentBinding)

Responses

Response Schema: application/json
registered
required
any
Value: true
dIdClassification
required
string
Enum: "native" "foreign"

Whether any registered binding targets a D-Id (identityKind-annotated) field:

  • native — no binding touches an identity field.
  • foreign — at least one binding sets an identity field, so the channel supplies (part of) the document's D-Id.

Request samples

Content type
application/json
{
  • "bindings": [
    ]
}

Response samples

Content type
application/json
{
  • "registered": true,
  • "dIdClassification": "native"
}

Get a channel's enrichment bindings

path Parameters
channelId
required
string

The channel identifier.

Responses

Response Schema: application/json
Array
fieldPath
required
string
staticValue
required
any

The static value injected at fieldPath (any JSON type).

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Delete a channel's enrichment bindings

path Parameters
channelId
required
string

The channel identifier.

Responses

Response Schema: application/json
deleted
required
any
Value: true

Response samples

Content type
application/json
{
  • "deleted": true
}

Subscriptions

Webhook subscriptions by Document_Type or document identity.

Webhook delivery (outbound POST to the subscriber) Webhook

TamaDB → subscriber (not a request you make). When a store writes a subscribed node, TamaDB POSTs the delivery to the subscription's callbackUrl.

Body. By default (payloadFormat: raw) the body is exactly the document content you asked for — shaped by the subscription's retrievalSchema when retrievalMode is closed — with no TamaDB wrapper. With payloadFormat: envelope the same content is wrapped in delivery context. See SubscriptionOptions.

Headers. Every delivery, in either format, carries TamaDB's delivery context as the TamaDB-* HTTP headers below, so the body never has to. The Document_Type, D-Id and path values are percent-encoded exactly as in URL path segments: split a composed D-Id on the delimiter (default :) first, then decode each part.

Envelope fields. With payloadFormat: envelope the same context is also in the body, under the field names below. Every envelope field has a header equivalent carrying the same value, except where noted:

Envelope field Header Notes
subscriptionId TamaDB-Subscription-Id Identical.
documentType TamaDB-Document-Type The header is percent-encoded.
dId TamaDB-D-Id Envelope: a string, or an array of strings for a composed D-Id. Header: URL form, e.g. ORD-1001:L-1 (percent-encoded parts joined by :).
path TamaDB-Path Node-scoped subscriptions only. The header is percent-encoded.
timestamp TamaDB-Enqueued-At The same instant: when the delivery snapshot was captured. A delivery time, not a stored document timestamp, and unrelated to any timestamp field inside document.
document none The projected document content. In raw format this is the whole body.

Delivery is snapshot-at-enqueue and governed by the subscription's delivery mode: fire-and-forget (a single attempt) or retry (bounded exponential backoff). A retry re-sends the identical body and headers. Your endpoint SHOULD respond 2xx to acknowledge; any non-2xx, timeout, or connection error is treated as a failed attempt.

header Parameters
TamaDB-Subscription-Id
required
string
Example: sub-mv65oc4u-0002

The subscription that matched the write.

TamaDB-Document-Type
required
string
Example: temperature-readings

The Document_Type of the written document, percent-encoded.

TamaDB-D-Id
required
string
Example: GARAGE-TEMP-01

The written document's identity in URL form: a single key as-is, or a composed key as its percent-encoded parts joined by the delimiter (default :), e.g. ORD-1001:L-1.

TamaDB-Enqueued-At
required
string <date-time>
Example: 2026-11-10T22:27:58.540Z

When the delivery snapshot was captured (UTC, millisecond precision). This is a delivery time, not the document's own stored timestamps.

TamaDB-Path
string
Example: temperature

Present only when the subscription is node-scoped: the percent-encoded dot-notation leaf or bunch path it targets.

Request Body schema: application/json

The delivery body. raw (the default) is the document content itself; envelope wraps it with delivery context.

Any of
property name*
additional property
any

Responses

Request samples

Content type
application/json
Example
{
  • "sensorId": "GARAGE-TEMP-01",
  • "temperature": 22,
  • "humidity": 40
}

Create a webhook subscription

Subscribe to document events by document_type or document_id scope. When scope is document_id, provide dId.

Request Body schema: application/json
required
scope
required
string
Enum: "document_type" "document_id"

What the subscription watches:

  • document_type — fires for any document of documentType.
  • document_id — fires for one specific document (requires dId).
documentType
required
string
dId
string

Required when scope is document_id.

callbackUrl
required
string <uri>
path
string

Optional node-scoped target: a dot-notation leaf or bunch path. When present, the subscription fires only when a store writes that node (or, for a bunch path, any leaf within it) — not on every write to the document. Triggering is presence-in-write and content-agnostic: it does not depend on whether the written value changed.

object (SubscriptionOptions)

Per-subscription delivery options. All fields are optional on create; omitted fields take the defaults shown. The server returns the fully resolved set (defaults filled in) on the subscription record.

Responses

Response Schema: application/json
id
required
string

Server-assigned subscription identifier.

scope
required
string
Enum: "document_type" "document_id"

document_type fires for any document of the type; document_id fires for the single document named by dId.

documentType
required
string
string or Array of strings (DId)
callbackUrl
required
string <uri>
path
string

Node-scoped target: a dot-notation leaf or bunch path. Present on a document_id subscription that targets a specific node; the subscription then fires only when a store writes that node (or, for a bunch path, any leaf within it). Absent means whole-document scope (fires on any write to the document).

object

The fully resolved delivery options (defaults filled in). See SubscriptionOptions.

createdAt
string <date-time>
active
boolean

Request samples

Content type
application/json
{
  • "scope": "document_type",
  • "documentType": "temperature-readings",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "id": "sub-muu900km-0001",
  • "scope": "document_type",
  • "documentType": "temperature-readings",
  • "options": {
    },
  • "createdAt": "2026-07-17T10:15:00Z",
  • "active": true
}

Cancel a subscription

path Parameters
subscriptionId
required
string

Responses

Response Schema: application/json
cancelled
required
any
Value: true

Response samples

Content type
application/json
{
  • "cancelled": true
}

List subscriptions for a document

path Parameters
documentType
required
string

The Document_Type name.

dId
required
string
Examples:
  • GARAGE-TEMP-01 - Single-key D-Id
  • ORD-1001:L-1 - Composed (multi-field) D-Id
  • * - Glob (match all)

The document identity. A composed D-Id joins its percent-encoded parts with the : delimiter (e.g. ORD-1001:L-1). Glob characters (*, ?) switch GET to glob retrieval.

Responses

Response Schema: application/json
Array
id
required
string

Server-assigned subscription identifier.

scope
required
string
Enum: "document_type" "document_id"

document_type fires for any document of the type; document_id fires for the single document named by dId.

documentType
required
string
string or Array of strings (DId)
callbackUrl
required
string <uri>
path
string

Node-scoped target: a dot-notation leaf or bunch path. Present on a document_id subscription that targets a specific node; the subscription then fires only when a store writes that node (or, for a bunch path, any leaf within it). Absent means whole-document scope (fires on any write to the document).

object

The fully resolved delivery options (defaults filled in). See SubscriptionOptions.

createdAt
string <date-time>
active
boolean

Response samples

Content type
application/json
[
  • {
    }
]

List subscriptions for a Document_Type

path Parameters
documentType
required
string

The Document_Type name.

Responses

Response Schema: application/json
Array
id
required
string

Server-assigned subscription identifier.

scope
required
string
Enum: "document_type" "document_id"

document_type fires for any document of the type; document_id fires for the single document named by dId.

documentType
required
string
string or Array of strings (DId)
callbackUrl
required
string <uri>
path
string

Node-scoped target: a dot-notation leaf or bunch path. Present on a document_id subscription that targets a specific node; the subscription then fires only when a store writes that node (or, for a bunch path, any leaf within it). Absent means whole-document scope (fires on any write to the document).

object

The fully resolved delivery options (defaults filled in). See SubscriptionOptions.

createdAt
string <date-time>
active
boolean

Response samples

Content type
application/json
[
  • {
    }
]

Quarantine

Inspect quarantined (rejected) ingestion payloads.

List quarantined payloads

query Parameters
rejectionType
string
Enum: "parse-error" "validation-failure" "enrichment-conflict"

Filter by why the payload was quarantined (the same value set as a quarantine entry's context.rejectionType):

  • parse-error — the body was not valid JSON (PARSE_ERROR).
  • validation-failure — the document failed schema validation.
  • enrichment-conflict — a channel enrichment binding conflicted with the payload under a discard-and-error policy.
sourceIdentifier
string

Filter by the ingestion source identifier (e.g. channel).

limit
integer >= 0
offset
integer >= 0

Responses

Response Schema: application/json
required
Array of objects (QuarantineEntry)
count
required
integer

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "count": 1
}

Retrieve a quarantine entry

path Parameters
quarantineRef
required
string

Responses

Response Schema: application/json
ref
string

Quarantine reference (the quarantineRef returned on rejection).

payload
any

The rejected payload (as received).

object

Response samples

Content type
application/json
{
  • "ref": "qr-muu900r6-0001",
  • "payload": {
    },
  • "context": {
    }
}

Configuration

Instance-level configuration (TTL, storage, logging, policies).

Get the instance default TTL

Responses

Response Schema: application/json
required
integer or "infinite" (string) (Ttl)

Response samples

Content type
application/json
{
  • "ttl": "infinite"
}

Set the instance default TTL

Request Body schema: application/json
required
required
integer or "infinite" (string) (Ttl)

Responses

Response Schema: application/json
required
integer or "infinite" (string) (Ttl)
object (TtlWarning)

Emitted when a requested TTL was raised to the configured floor.

Request samples

Content type
application/json
{
  • "ttl": 1800
}

Response samples

Content type
application/json
{
  • "ttl": 1800
}

Set the TTL sweep interval

Request Body schema: application/json
required
interval
required
integer

Sweep interval in milliseconds.

Responses

Response Schema: application/json
sweepInterval
required
integer

Request samples

Content type
application/json
{
  • "interval": 60000
}

Response samples

Content type
application/json
{
  • "sweepInterval": 60000
}

Get the active storage strategy

Responses

Response Schema: application/json
mode
required
string (StorageMode)
Enum: "auto" "memory" "disk" "hybrid"

The storage strategy governing where documents are held:

  • auto — the engine selects a strategy automatically.
  • memory — in-memory only (fastest; not durable across restart).
  • disk — persisted to disk (durable; nothing buffered in memory).
  • hybrid — in-memory working set with disk persistence.

/health reports the active mode; GET/PUT /api/v1/config/storage-strategy reads and changes it at runtime.

Response samples

Content type
application/json
{
  • "mode": "memory"
}

Set the storage strategy

Request Body schema: application/json
required
mode
required
string (StorageMode)
Enum: "auto" "memory" "disk" "hybrid"

The storage strategy governing where documents are held:

  • auto — the engine selects a strategy automatically.
  • memory — in-memory only (fastest; not durable across restart).
  • disk — persisted to disk (durable; nothing buffered in memory).
  • hybrid — in-memory working set with disk persistence.

/health reports the active mode; GET/PUT /api/v1/config/storage-strategy reads and changes it at runtime.

Responses

Response Schema: application/json
mode
required
string (StorageMode)
Enum: "auto" "memory" "disk" "hybrid"

The storage strategy governing where documents are held:

  • auto — the engine selects a strategy automatically.
  • memory — in-memory only (fastest; not durable across restart).
  • disk — persisted to disk (durable; nothing buffered in memory).
  • hybrid — in-memory working set with disk persistence.

/health reports the active mode; GET/PUT /api/v1/config/storage-strategy reads and changes it at runtime.

Request samples

Content type
application/json
{
  • "mode": "hybrid"
}

Response samples

Content type
application/json
{
  • "mode": "hybrid"
}

Drain buffered documents to persistent storage

Responses

Response Schema: application/json
drained
required
any
Value: true
documentsWritten
required
integer
mode
required
string

Response samples

Content type
application/json
{
  • "drained": true,
  • "documentsWritten": 0,
  • "mode": "hybrid"
}

Get the quarantine policy

Responses

Response Schema: application/json
policy
required
string (QuarantinePolicyValue)
Enum: "off" "data-errors-only" "all-rejections"

Which rejected ingests are captured in quarantine:

  • off — nothing is quarantined.
  • data-errors-only — only producer-content (payload-stage) errors: a malformed body (PARSE_ERROR) or a schema/enrichment validation failure. Control-plane and routing/config rejections are excluded. (A rename to payload-errors-only is a deferred breaking change.)
  • all-rejections — every rejection, including routing/config errors.

Response samples

Content type
application/json
{
  • "policy": "data-errors-only"
}

Set the quarantine policy

Request Body schema: application/json
required
policy
required
string (QuarantinePolicyValue)
Enum: "off" "data-errors-only" "all-rejections"

Which rejected ingests are captured in quarantine:

  • off — nothing is quarantined.
  • data-errors-only — only producer-content (payload-stage) errors: a malformed body (PARSE_ERROR) or a schema/enrichment validation failure. Control-plane and routing/config rejections are excluded. (A rename to payload-errors-only is a deferred breaking change.)
  • all-rejections — every rejection, including routing/config errors.

Responses

Response Schema: application/json
policy
required
string (QuarantinePolicyValue)
Enum: "off" "data-errors-only" "all-rejections"

Which rejected ingests are captured in quarantine:

  • off — nothing is quarantined.
  • data-errors-only — only producer-content (payload-stage) errors: a malformed body (PARSE_ERROR) or a schema/enrichment validation failure. Control-plane and routing/config rejections are excluded. (A rename to payload-errors-only is a deferred breaking change.)
  • all-rejections — every rejection, including routing/config errors.

Request samples

Content type
application/json
{
  • "policy": "all-rejections"
}

Response samples

Content type
application/json
{
  • "policy": "all-rejections"
}

Get enrichment policies

Responses

Response Schema: application/json
precedence
string
Enum: "environment-over-content" "content-over-environment"

Who wins when a channel enrichment binding and the producer payload both set the same field:

  • environment-over-content — the channel-configured (environment) value overrides the producer-supplied value.
  • content-over-environment — the producer-supplied value wins.
conflictResolution
string
Enum: "accept-and-warn" "discard-and-error"

What happens on an enrichment conflict:

  • accept-and-warn — apply the precedence rule, store the document, and emit a warning.
  • discard-and-error — reject the ingest with ENRICHMENT_CONFLICT (and quarantine per policy).

Response samples

Content type
application/json
{
  • "precedence": "environment-over-content",
  • "conflictResolution": "accept-and-warn"
}

Set enrichment policies

Request Body schema: application/json
required
precedence
string
Enum: "environment-over-content" "content-over-environment"

Who wins when a channel enrichment binding and the producer payload both set the same field:

  • environment-over-content — the channel-configured (environment) value overrides the producer-supplied value.
  • content-over-environment — the producer-supplied value wins.
conflictResolution
string
Enum: "accept-and-warn" "discard-and-error"

What happens on an enrichment conflict:

  • accept-and-warn — apply the precedence rule, store the document, and emit a warning.
  • discard-and-error — reject the ingest with ENRICHMENT_CONFLICT (and quarantine per policy).

Responses

Response Schema: application/json
precedence
string
Enum: "environment-over-content" "content-over-environment"

Who wins when a channel enrichment binding and the producer payload both set the same field:

  • environment-over-content — the channel-configured (environment) value overrides the producer-supplied value.
  • content-over-environment — the producer-supplied value wins.
conflictResolution
string
Enum: "accept-and-warn" "discard-and-error"

What happens on an enrichment conflict:

  • accept-and-warn — apply the precedence rule, store the document, and emit a warning.
  • discard-and-error — reject the ingest with ENRICHMENT_CONFLICT (and quarantine per policy).

Request samples

Content type
application/json
{
  • "precedence": "content-over-environment"
}

Response samples

Content type
application/json
{
  • "precedence": "content-over-environment",
  • "conflictResolution": "accept-and-warn"
}

Get the logging state (level)

Responses

Response Schema: application/json
level
string (LogLevel)
Enum: "debug" "info" "warn" "error" "silent"

The active log verbosity, most to least verbose:

  • debug — everything (default).
  • info — informational events and above.
  • warn — warnings and errors only.
  • error — errors only.
  • silent — logging disabled.
destination
string (LogDestination)
Enum: "stdout" "file" "none"

Where log output is written:

  • stdout — standard output (default).
  • file — a file on disk (requires filePath).
  • none — discard log output.
filePath
string

Target file path; present/relevant when destination is file.

property name*
additional property
any

Response samples

Content type
application/json
{
  • "level": "warn",
  • "destination": "stdout"
}

Set the log level

Request Body schema: application/json
required
level
required
string (LogLevel)
Enum: "debug" "info" "warn" "error" "silent"

The active log verbosity, most to least verbose:

  • debug — everything (default).
  • info — informational events and above.
  • warn — warnings and errors only.
  • error — errors only.
  • silent — logging disabled.

Responses

Response Schema: application/json
level
string (LogLevel)
Enum: "debug" "info" "warn" "error" "silent"

The active log verbosity, most to least verbose:

  • debug — everything (default).
  • info — informational events and above.
  • warn — warnings and errors only.
  • error — errors only.
  • silent — logging disabled.
destination
string (LogDestination)
Enum: "stdout" "file" "none"

Where log output is written:

  • stdout — standard output (default).
  • file — a file on disk (requires filePath).
  • none — discard log output.
filePath
string

Target file path; present/relevant when destination is file.

property name*
additional property
any

Request samples

Content type
application/json
{
  • "level": "info"
}

Response samples

Content type
application/json
{
  • "level": "info",
  • "destination": "stdout"
}

Get the logging state (destination)

Responses

Response Schema: application/json
level
string (LogLevel)
Enum: "debug" "info" "warn" "error" "silent"

The active log verbosity, most to least verbose:

  • debug — everything (default).
  • info — informational events and above.
  • warn — warnings and errors only.
  • error — errors only.
  • silent — logging disabled.
destination
string (LogDestination)
Enum: "stdout" "file" "none"

Where log output is written:

  • stdout — standard output (default).
  • file — a file on disk (requires filePath).
  • none — discard log output.
filePath
string

Target file path; present/relevant when destination is file.

property name*
additional property
any

Response samples

Content type
application/json
{
  • "level": "info",
  • "destination": "stdout"
}

Set the log destination

Request Body schema: application/json
required
destination
required
string (LogDestination)
Enum: "stdout" "file" "none"

Where log output is written:

  • stdout — standard output (default).
  • file — a file on disk (requires filePath).
  • none — discard log output.
filePath
string

Required when destination is file.

Responses

Response Schema: application/json
level
string (LogLevel)
Enum: "debug" "info" "warn" "error" "silent"

The active log verbosity, most to least verbose:

  • debug — everything (default).
  • info — informational events and above.
  • warn — warnings and errors only.
  • error — errors only.
  • silent — logging disabled.
destination
string (LogDestination)
Enum: "stdout" "file" "none"

Where log output is written:

  • stdout — standard output (default).
  • file — a file on disk (requires filePath).
  • none — discard log output.
filePath
string

Target file path; present/relevant when destination is file.

property name*
additional property
any

Request samples

Content type
application/json
{
  • "destination": "stdout"
}

Response samples

Content type
application/json
{
  • "level": "info",
  • "destination": "stdout"
}