Core Concepts

Nimbus is organized around a small number of primitives. Understanding how they relate makes the rest of the docs much easier to follow.

graph TD
    A[Organization] --> B[Project]
    B --> C[Bucket]
    C --> D[Record]
    B --> E[Webhook]
    B --> F[API Key]

Organization

The top-level account that billing and team membership are attached to. Every project belongs to exactly one organization.

Project

A project is an isolated namespace with its own buckets, webhooks, and API keys. Most teams create one project per environment (staging, production) or per application.

Bucket

A bucket is a named collection of records, similar to a table. Buckets have a retention policy and an encryption setting, configured via nimbus.yml.

Record

A record is a single JSON document stored in a bucket, addressed by a unique name within that bucket.

Webhook

A subscription that POSTs an event payload to a URL you control whenever something happens in a project — see Webhooks.

API Key

A credential scoped to an organization or project, used to authenticate requests. See Authentication.

Naming

Bucket and record names must be lowercase, may contain hyphens, and are limited to 128 characters.