Skip to main content

Quick Start

Get metrics flowing into xScaler in three steps.

Prerequisites

Before you begin, locate the following in your xScaler dashboard → Settings → API Tokens:

ValueDescription
Region endpointe.g. euw1-01.m.xscalerlabs.com
Tenant IDYour X-Scope-OrgID value
API tokenYour Authorization: Bearer token

:::warning Both headers are required on every request Every request to xScaler — reads and writes — must include:

Authorization: Bearer <token>
X-Scope-OrgID: <tenant-id>

If X-Scope-OrgID is missing, the backend returns 400 Bad Request ("no org id"). If Authorization is missing or invalid, it returns 401 Unauthorized. :::


Step 1 — Verify connectivity

Send a test query to confirm your credentials and endpoint work:

curl "https://euw1-01.m.xscalerlabs.com/prometheus/api/v1/query" \
-H "Authorization: Bearer <token>" \
-H "X-Scope-OrgID: <tenant-id>" \
--data-urlencode 'query=up'

A successful response looks like:

{
"status": "success",
"data": {
"resultType": "vector",
"result": []
}
}

An empty result array is expected if you haven't sent any metrics yet — it means authentication succeeded and your tenant namespace is reachable.


Step 2 — Choose your ingest method

Pick the method that matches your stack:

I use…Guide
PrometheusPrometheus remote_write
Grafana AlloyGrafana Alloy
OpenTelemetry CollectorOpenTelemetry Collector
Python applicationOTel SDK — Python
Node.js applicationOTel SDK — Node.js
Go applicationOTel SDK — Go

Step 3 — Connect Grafana

Once metrics are flowing, visualise them in Grafana:

  • Set the Prometheus server URL to https://euw1-01.m.xscalerlabs.com/prometheus
  • Add Authorization: Bearer <token> and X-Scope-OrgID: <tenant-id> as custom HTTP headers

See the full walkthrough in Grafana Integration.


Common errors

ErrorCauseFix
400 no org idX-Scope-OrgID header missingAdd -H "X-Scope-OrgID: <tenant-id>"
401 UnauthorizedToken missing or malformedCheck format: Bearer <token> (capital B, space)
403 ForbiddenToken scope too narrowGenerate a read+write token from the dashboard

See Troubleshooting for a full symptom guide.