Skip to main content

Lifecycle

Endpoint reference

OpenAPI scope: api-reference/openapi.json documents /tenants/create, /tenants/infra/status, /tenants/monitor, /tenants/sub_tenant_ids, and /tenants/delete. The companion page List tenant IDs describes GET /tenants/tenant_ids, which does not appear in that OpenAPI file.

Typical call sequence

For a new tenant from scratch:
For routine operations on an existing tenant:
For teardown:

Key concepts

  • Tenant – Top-level isolated workspace. One per organization in most cases.
  • Sub-tenant – Subdivision inside a tenant. Created automatically the first time a sub_tenant_id is used. No explicit creation step, no confirmation.
  • Default sub-tenant – Every tenant gets one at creation. API calls that omit sub_tenant_id target this default.
  • Tenant metadata schema – Immutable field definitions set at creation. Cannot be changed later.