Eve library

Health API Documentation

Guide

Revision 1

On this page

Overview#

Base URL#

text
http://localhost:3001/api/v1

Authentication#

All API endpoints require authentication via JWT token:

text
Authorization: Bearer <your-jwt-token>

Endpoints#

GET /v1/health#

Liveness/Readiness probe

Parameters: None

Responses:

  • 200: OK

Operation ID: getHealth

Rate Limiting#

All endpoints are subject to rate limiting:

  • Burst limit: 100 requests per minute
  • Sustained rate: 1000 requests per hour

Error Handling#

Standard error response format:

json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message",
    "details": {}
  }
}

Generated automatically from OpenAPI specification