Manage API Tokens

API tokens (access keys) authenticate remote_write and query requests. Each token covers one tenant. Send it as a Bearer token in the Authorization header alongside X-Scope-OrgID.

---

View API tokens for a tenant

1. Go to Tenants in the sidebar (under Organization).
2. Click the tenant name.
3. Scroll to the API keys section at the bottom of the detail page.

The table shows each key's name, status, last used time, and creation date.

---

Create a new API token

1. Open the tenant detail page (Organization → Tenants → click tenant name).
2. In the API keys section, click New key.
3. Enter a name for the key (e.g. prometheus-prod, alloy-staging).
4. Click Create.
5. Copy the token immediately. It is only shown once.

Token shown once

The portal shows the full token once, at creation. Store it in a secrets manager or a Kubernetes secret. If you lose it, rotate the key.

---

Rotate an API token

Rotating a key issues a new token and kills the old one. Rotate after a possible exposure, or on a schedule.

1. Open the tenant detail page (Organization → Tenants → click tenant name).
2. In the API keys table, find the key to rotate.
3. Click the rotate icon (circular arrow) on that row.
4. Copy the new token. It is only shown once.
5. Update your remote_write config with the new token before the old one is invalidated.

Zero-downtime rotation

Update your metrics collector config with the new token before closing the rotation dialog. The old token is invalidated as soon as you confirm.

---

Revoke an API token

Revoking deletes a token for good. Requests carrying it get HTTP 401 immediately.

1. Open the tenant detail page (Organization → Tenants → click tenant name).
2. In the API keys table, find the key to revoke.
3. Click the revoke icon (trash / X) on that row.
4. Confirm the action.

The key leaves the list and stops working.

---

Using a token in your collector

Every request to xScaler requires both headers:

# Prometheus
remote_write:
  - url: https://euw1-01.m.xscalerlabs.com/api/v1/push
    authorization:
      credentials: <token>
    headers:
      X-Scope-OrgID: <tenant-id>

# Grafana Alloy
prometheus.remote_write "xscaler" {
  endpoint {
    url = "https://euw1-01.m.xscalerlabs.com/api/v1/push"
    authorization {
      type        = "Bearer"
      credentials = "<token>"
    }
    headers = { "X-Scope-OrgID" = "<tenant-id>" }
  }
}

---

Audit trail

xScaler logs every token operation in the Activity log:

Event	Triggered by
api_key.created	New key created
api_key.rotated	Key rotated
api_key.revoked	Key revoked