---
title: "`GET /admin/clearance`; the clearance artefact inventory: what is published, whether it still matches its sources, and what the bake said about its own quality."
method: GET
path: "/admin/clearance"
tags: ["admin"]
---

# \`GET /admin/clearance\`; the clearance artefact inventory: what is published, whether it still matches its sources, and what the bake said about its own quality.

`GET /admin/clearance`

## Request

- Base URL: `https://api.mapmap.ai`
- URL: `https://api.mapmap.ai/admin/clearance`
- Auth: `admin_bearer` (a scheme the document does not define)

Read-only, and unfiltered by customer visibility: this is the operator's
view of the deployment.

## Response `200`

Clearance artefacts, staleness and QA stats

- ClearanceOverview: Response for `GET /admin/clearance`.
  - `artefacts` ClearanceArtefactRow[], required: Every dataset carrying a clearance block, dataset order, whether or not its artefact could be read.
    - `artefact` string, required: Artefact stem under `<dataset>/clearance/`.
    - `cell_size_m` number, double, nullable: Grid cell size in metres.
    - `crs_epsg` integer, nullable: EPSG code of the grid's projected CRS.
    - `dataset` string, required: Dataset id (directory name).
    - `error` string, nullable: Why it did not open. Present only on `unreadable` rows.
    - `grid` integer[], nullable: Grid dimensions, columns by rows.
    - `qa` QaOut: The bake's QA block as published, plus nothing computed here.
      - `cells_overhead` integer, required: Cells carrying a validated overhead surface.
      - `cells_road` integer, required: Cells carrying a road surface.
      - `cells_total` integer, required: Cells in the grid.
      - `road_z_mad_m` number, double, required: Median absolute deviation of the road **surface height** across the grid, metres, exactly as the bake published it. Not a quality score, and it should not be read as one: it measures the terrain rather than the fit, so it runs to metres wherever a ramp climbs and to centimetres on the flat. A gradient is not a bad bake.
      - `synthetic_checks_passed` boolean, required: Whether the bake's own synthetic checks passed.
    - `sources_confirmed` integer, required: Sources the bake recorded that the manifest still confirms.
    - `sources_declared` integer, required: Source files the manifest declares for this dataset.
    - `stale` boolean, required: Whether the artefact lags the sources the manifest declares, or cannot be confirmed against them. Either way it decides no `pass`.
    - `status` string, required: `ok` when the artefact opened, `unreadable` when it did not.
    - `survey_dates` string, nullable: Capture range, `from/to` in ISO dates.
    - `vertical_datum` string, nullable: The vertical frame, spelled for a reader.
  - `enabled` boolean, required: Whether any clearance artefact is configured at all. `false` is what makes `POST /v1/clearance/along` answer 501.

## Other responses

- `401`: Missing or wrong admin token

---

[API](https://skmtc.dev/mapmap/apis/sn-gateway.md) · [All operations](https://skmtc.dev/mapmap/apis/sn-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/mapmap/apis/sn-gateway/revisions/2293be8b4c38?raw)