Documentation menu
meta
GET/status
API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….
What it does
Answers JSON, or a self-contained HTML page when the request prefers
text/html (a browser). Always 200, even when the backend is
degraded: /health is the probe a monitor should watch, and this is
the page an operator reads.
Call it
bash
curl -fsS -X GET "https://api.mapmap.ai/status" \
-H "Authorization: Bearer $MAPMAP_KEY"Responses
200What this deployment is serving: build, backend, uptime, territories, DEM sources, which optional features are on (booleans only), the number of live keys and today's total metered units. A browser (
Accept: text/html) gets the same report as a self-contained page. Read-only, no admin actions, and never key material, per-key data or any configured secret| Field | Type | Required | Description |
|---|---|---|---|
| backend | string | yes | Name of the routing engine serving requests (valhalla,
graphhopper or auto), as /health reports it. |
| build | string | yes | Git commit the running image was built from (SN_BUILD_SHA), or
unknown, as /health reports it. |
| features | Features | yes | Which optional features this deployment switched on. Booleans only: never a URL, a path or a credential. |
| keys | KeyCounts | yes | API keys, counted only. |
| status | string | yes | ok when the routing backend answers its health probe, degraded
otherwise. Unlike /health, the HTTP status is always 200: this is
a page, not a probe, and a monitor should watch /health. |
| terrain | TerrainStatus | yes | The DEM/terrain sources the operator declared. |
| territories | TerritoryStatus[] | yes | Territories this box serves, from the update-channel index and the tiles directory. Empty when the deployment publishes neither. |
| uptime_s | integer | yes | Seconds since this gateway process finished starting. |
| usage_today | UsageToday | yes | Today's metered volume, aggregated across every key. |
| version | string | yes | Gateway crate version, as /health reports it. |
401No API key (unless the deployment sets
SN_STATUS_PUBLIC=true)Error bodies follow the shared problem model documented on API conventions.
Also under meta
Generated from https://api.mapmap.ai/openapi.json on 2026-09-17 · operationId get_status