Health

GET

/health

const url = 'https://example.com/api/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Health check endpoint for ALB, Docker, and Nginx.

Responses

200

Successful Response

application/json

HealthResponse

object

status

required

Status

string

providers

required

Providers

object

key

additional properties

ServiceHealth

object

status

required

Status

string

latency_ms

Any of:

number
null

number

error

Any of:

string
null

string

Example ^generated

{
  "status": "example",
  "providers": {
    "additionalProperty": {
      "status": "example",
      "latency_ms": 1,
      "error": "example"
    }
  }
}

Health

Responses

200

Example generated

Example ^generated