Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.yertle.com/health
{
  "status": "<string>",
  "message": "<string>",
  "version": "<string>",
  "lambda_version": "<string>",
  "environment": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.yertle.com/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

Successful Response

Basic liveness/version signal for the API.

status
string
required

Service status (e.g. 'healthy')

message
string
required

Human-readable status message

version
string
required

Deployed git version (e.g. 'a17059ab-b2')

lambda_version
string
required

AWS Lambda numbered version serving this request (e.g. '42')

environment
string
required

Environment name (dev/prod)