Authentication & scopes
Client access is separate from upstream BYOK credentials and supports all eight product scopes.
On this page 3 sections
#Send a gateway client key
curl -H "X-API-Key: YOUR_GATEWAY_KEY" \
"http://127.0.0.1:8080/v1/weather?lat=21.21&lon=81.43"The Authorization: Bearer header is also supported. Never pass client keys in URL query strings. Key-usage timestamp updates (LastUsedAt) are coalesced asynchronously in a bounded 2,048-entry queue so authentication lookups remain fast while preserving immediate revocation semantics.
#Scope mapping across all 10 routes
| Endpoint | Required scope | Release profile |
|---|---|---|
/v1/datasets | per requested dataset | lean_v1 |
/v1/weather | weather:read | lean_v1 |
/v1/forecast | forecast:read | lean_v1 |
/v1/forecast/daily | forecast:read | lean_v1 |
/v1/geocode | geocode:read | lean_v1 |
/v1/astronomy | astronomy:read | lean_v1 |
/v1/air-quality | air-quality:read | full_experimental |
/v1/history | history:read | full_experimental |
/v1/marine | marine:read | full_experimental |
/v1/alerts | alerts:read | full_experimental |
#Provisioning scoped keys with uapctl
With APP_DATABASE_URL configured, the offline uapctl CLI supports provisioning client keys across all eight product scopes (weather:read, geocode:read, forecast:read, air-quality:read, history:read, astronomy:read, marine:read, alerts:read):
go run ./cmd/uapctl create-key --name prod-client \
--scopes weather:read,geocode:read,forecast:read,astronomy:read \
--expires-in 2160hThe tool writes the plaintext secret once to stdout and the key ID to stderr. Store the secret securely outside logs and repositories.
docs/openapi.yaml (lean_v1) and docs/openapi.experimental.yaml · Verify against your build before production use.