Skip to main content
GET
/
api
/
health
/
ping
Health ping
curl --request GET \
  --url https://api.example.com/api/health/ping
{
  "status": "<string>",
  "version": "<string>",
  "build_number": "<string>"
}

Documentation Index

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

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

Response

Health check successful.

​
status
string
required

The current health status of the API.

​
version
string
required

The version of the API currently running.

​
build_number
string
required

The build number of the deployed API.