Skip to main content

​
Endpoint

GET /
Simple health check endpoint that returns the current status of the Highway API server.

​
Request

No parameters required.

​
Response

​
message
string
Status message indicating the server is running

​
Success Response

Status Code: 200 OK 
{
  "message": "Running"
}

​
Usage

Use this endpoint to:
  • Verify the API server is operational
  • Monitor uptime in health check scripts
  • Confirm deployment success
  • Test API connectivity

​
Code Examples

curl https://your-server.com/

​
Monitoring Example

Use this endpoint in monitoring scripts: 
#!/bin/bash
# Health check script

RESPONSE=$(curl -s https://your-server.com/)
STATUS=$(echo $RESPONSE | jq -r '.message')

if [ "$STATUS" = "Running" ]; then
  echo "✓ API is healthy"
  exit 0
else
  echo "✗ API is down"
  exit 1
fi
This endpoint is implemented at /home/daytona/workspace/source/highway-backend/routes.js:23 and requires no authentication.

Build docs developers (and LLMs) love

Get started for freeTalk to us