Admin

Get Basemaps

Return the configured basemap list (public, no auth required).

Basemaps with {api_key} in the URL are filtered out when no key is configured. When a key IS set the placeholder is resolved server-side. The response uses BasemapPublicResponse which excludes api_key.

The resolved url field intentionally includes the substituted api_key value when configured. Client-side tile-provider keys (Mapbox, Stadia, MapTiler) are designed for browser exposure and the frontend MUST receive them to load tiles. Do NOT put a backend-only provider key in this field. Rotate the key in the provider dashboard if it is misused. Rate-limited via _basemap_proxy_rate_limit to cap replay-cost from anonymous clients.

get/settings/basemaps/

Request

  • The document declares no server URL.
  • Auth: none declared

Response

Successful Response

idstring required

Unique basemap identifier.

labelstring required

Display label.

urlstring required

Tile URL or style JSON URL with API key already substituted (or omitted) for client use.

enabledboolean required

Whether the basemap is currently selectable.

is_presetboolean required

Whether this is a built-in preset.

attributionstring nullable

Attribution string for the basemap source.

Changes

No recorded changes to this operation across all 50 revisions of this API.