Skip to main content

Start here

Start here gets you to a verified first request with the smallest set of concepts and setup steps.

What you will do​

  1. Choose a deployment model (Cloud or self-hosted).
  2. Bootstrap a realm and a service key (server-side credentials).
  3. Verify you can call Vluna and interpret success vs failure.
  4. Understand the identifiers you must keep stable in production.

Reading order​

  1. Concepts and system flow
  2. Deployment:
  3. Verify installation and integration
  4. Identifiers and lifecycles

Minimal required concepts (keep it to these for now)​

  • realm_id: Your project boundary. Every request must include X-Realm-Id.
  • Service key (service_key_id and service_key_secret): Server-to-server authentication for /mgt/v1.
  • principal_id: Your stable identifier for the billing principal (usually an org, team, or customer id).
  • billing_account_id: Vluna's billing account identifier, mapped 1:1 with principal_id.
  • Idempotency-Key: Required for write requests. Reuse it when retrying the same logical operation.

Where to go next​