These routes cover service health, configuration, auth, storage cleanup, cache administration, and built-in viewer pages.
Health, Root, and Config
| Method | Path | Purpose | Auth |
|---|
GET | / | browser-facing root redirect into the frontend UI | no |
GET | /health | liveness probe for service/container health | no |
GET | /config | expose effective runtime configuration | no |
POST | /config | persist runtime configuration overrides | yes |
POST | /config/reset | reset persisted configuration back to environment defaults | yes |
POST | /storage/cleanup-tmp | clear temporary working files under runtime storage | yes |
Auth
| Method | Path | Purpose | Auth |
|---|
POST | /token | issue bearer token using the password-flow form | no |
POST | /login | alias for /token used by Swagger login flows | no |
MapCache Administration
| Method | Path | Purpose | Auth |
|---|
POST | /mapcache/reload | regenerate mapcache.xml and trigger reload behavior | yes |
GET | /mapcache/cache/layers | list cache directories and layer usage | no |
POST | /mapcache/cache/layers | inspect or create cache-layer bookkeeping | yes |
POST | /mapcache/cache/cleanup | remove cached tiles using cleanup filters | yes |
POST | /mapcache/cache/cleanup-layers | delete entire cache layer directories | yes |
Built-In Viewers and Test Pages
| Method | Path | Purpose |
|---|
GET | /ui/ | operator frontend |
GET | /guide/ | Docusaurus documentation site |
GET | /guide/blog | blog index for project updates and operational notes |
GET | /docs | Swagger UI |
GET | /openapi.json | OpenAPI schema export |
GET | /ui-react/ | React operator frontend |
GET | /maplibre/view | MapLibre viewer page |
GET | /cesium/hello | Cesium hello page |
GET | /cesium/ion | Cesium Ion example |
GET | /cesium/wms | Cesium WMS viewer |
GET | /cesium/terrain-test | terrain-oriented Cesium test page |
GET | /cesium/csw-search | Cesium-integrated CSW search page |
GET | /ogc/csw-info | HTML info page for OGC/CSW endpoint discovery |
Notes
- Runtime configuration is layered: environment defaults first, persisted config in
/data/server_config.json second.
- Cache cleanup routes operate on shared on-disk tile state, so use them carefully in multi-user or production-like scenarios.
- The docs site is served by the same API container as the REST endpoints, which keeps deployment simple and ensures
/guide versioning matches the running branch/image.
- The blog lives under the same mounted docs site, so
/guide/blog is part of the same static documentation build.