Skip to main content

Create a Tenant

A tenant is an isolated metrics namespace. Each tenant gets its own write endpoint, API token, and series quota. Create one tenant per environment (production, staging, dev) or per team.


Steps​

  1. Go to Tenants in the sidebar (under Organization).

  2. Click New tenant in the top-right corner.

  3. Fill in the optional fields:

    FieldDescription
    Display nameA human-readable label (e.g. production, team-payments). Shown in the portal but not used in API calls.
    EnvironmentFree-text tag to categorise the tenant (e.g. prod, staging). Optional.
  4. Click Create tenant.

  5. The portal shows the tenant credentials. Copy them now:

    CredentialWhat it's used for
    Access key (API token)Value for the Authorization: Bearer <token> header
    Write endpointURL for remote_write or OTLP export

    :::warning Token shown once The portal shows the API token once, at creation. If you lose it, rotate the key for a new one. :::

  6. Click Done. The new tenant appears in the tenants list with status Active.


What to do next​

Configure your metrics collector to send data to the new tenant. Both headers are required on every request:

# Prometheus remote_write
remote_write:
- url: <write endpoint>
authorization:
credentials: <api token>
headers:
X-Scope-OrgID: <tenant-id>
# Grafana Alloy
prometheus.remote_write "xscaler" {
endpoint {
url = "<write endpoint>"
authorization {
type = "Bearer"
credentials = "<api token>"
}
headers = { "X-Scope-OrgID" = "<tenant-id>" }
}
}

You find the tenant ID in the tenants list and on the tenant detail page.