Liveness + access probe

GET

/health

Confirms the gateway process is up and serving HTTP. If an X-API-Key
header is supplied, also reports whether the key is currently authorized
via the access field. The endpoint always returns 200 — invalid or
missing keys are reflected as access: false rather than an error.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Gateway is up.

Bodyapplication/json

Example

{
    "success": true,
    "data": {
        "status": "ok",
        "access": true,
        "uptime": 1287.42,
        "timestamp": "2026-05-01T12:34:56.789Z"
    }
}

Modified at 2026-05-25 11:54:46

Conventions

List NOGA classifications