UK Data AtlasAPI

Get the current release

Every response comes from the current Atlas release: a fingerprinted set of the artifacts behind the API. This returns its releaseId and artifact hashes.

get
/atlas-release

Good to know

  • Building from the same inputs always gives the same releaseId, so recording it lets you reproduce a result exactly.

Returns

AtlasReleaseEnvelope

The current atlas release manifest.

  • apiVersionv1required
  • atlasReleasestringrequired

    The immutable /atlas-release releaseId for the artifacts that produced this response.

  • metaobjectrequired
    Show1 child field
    • nextCursorstring | nullrequired

      Opaque cursor for the next page, or null at the end.

  • dataAtlasReleaserequired
    Show4 child fields
    • schemaVersion1required
    • releaseIdstringrequired
    • artifactsAtlasReleaseArtifactRef[]required
      Show3 child fields
      • idstringrequired
      • pathstringrequired
      • contentHashstringrequired
    • resourcesobjectoptional

      A fingerprint per resource id for each kind, read from artifacts the release already hashes, so it does not enter releaseId. A kind the release did not record is absent.

When it goes wrong

  • 503The referenced build artifact has not been built yet.

Every error has the same shape. See Errors for how to handle them.

Technical notes

Show the precise behaviour

References the boundary registry, derived boundaries, area inventory, named-location inventory, geometry source registry, crosswalk inventory, relationship-candidate inventory, geography inventory, validation report and source inventory by content hash, plus a single releaseId hash of that set. Rebuilding without changing any input reproduces the same releaseId.