Sign in
Datasets - Source Health

Check Source Health

Contact this dataset's origin and record what came back.

Owner-or-admin: this makes GeoLens issue an outbound request on the caller's behalf and writes to the dataset row. Readers get the stored result from GET /datasets/{id} instead.

post/datasets/{dataset_id}/source-health/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

dataset_idstring uuid required

Response

Successful Response

dataset_idstring uuid required
originstring nullable required

Origin kind that was probed: service or stac.

source_health'healthy' | 'missing' | 'inaccessible' required

healthy — the origin answered and the resource is there. missing — the origin answered authoritatively that it is gone (404/410). inaccessible — GeoLens could not determine either way, which includes 401/403: access was lost, the data may be intact.

source_health_detailstring nullable

Why the origin is not healthy, as one of a fixed set of GeoLens codes: auth_required, blocked_by_policy, item_withdrawn, network_error, not_found, server_error, timeout, unauthorized, unexpected_status. Null when healthy or never probed. Never provider text, a URL, or a response body — nothing the origin sent is stored here.

last_checked_atstring date-time nullable

When GeoLens last contacted this origin, success or failure.

Changes

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