Skip to content
getgeolens.com
GeoLens Docs

Health

GET
/health
 
curl --request GET \
  --url https://example.com/health

Health check endpoint for ALB, Docker, and Nginx.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
HealthResponse
object
build
Any of:
string
providers
required
Providers
object
key
additional properties
ServiceHealth
object
error
Any of:
string
latency_ms
Any of:
number
status
required
Status
string
status
required
Status
string
version
required
Version
string
Example generated
{
  "build": "example",
  "providers": {
    "additionalProperty": {
      "error": "example",
      "latency_ms": 1,
      "status": "example"
    }
  },
  "status": "example",
  "version": "example"
}

429

Section titled “429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “503 ”

Health probes completed but one or more providers are degraded

Media type application/json
HealthResponse
object
build
Any of:
string
providers
required
Providers
object
key
additional properties
ServiceHealth
object
error
Any of:
string
latency_ms
Any of:
number
status
required
Status
string
status
required
Status
string
version
required
Version
string
Example generated
{
  "build": "example",
  "providers": {
    "additionalProperty": {
      "error": "example",
      "latency_ms": 1,
      "status": "example"
    }
  },
  "status": "example",
  "version": "example"
}