Skip to main content

System

System health and version​

Used to retrieve information about the health status of the system.

Public nndpoints, no access token required.

  • Endpoint: /api/v5/system/health

  • HTTP Method: GET

  • Request Parameters: None

  • Response Format: JSON

Bash Example with CURL:​

curl -X GET <API_SERVICE_HOST>/api/v5/system/health

Example Response​

{
    "code": 0, 
    "status": "ok", 
    "service": "Open API", 
    "environment": "UAT", 
    "base_version": "v5", 
    "version": "2023-11-05"
}