Check API health

GET

/health

Last modified:2026-10-30 21:11:37

OperationId:GetHealthStatusAPI

Checks the cache, every configured database connection, and the messaging service on the server that answered, for load balancers and monitoring services. No token is needed; send any valid token, whatever its scope, to also get the result of each check.

Request

None

Responses

🟢200OK

application/json

The health report. The HTTP status is 200 whether the server is healthy or degraded: read status. Results are cached for 15 seconds per server, so a failure can take up to 15 seconds to show. The X-Health-Cache header is hit when the result came from that cache and miss when it was just computed. environment, php_version, and checks are present only when you send a valid bearer access token, API key, or ns_access_token cookie, of any scope.

Headers

Bodyapplication/json

🟠401Invalid token

🟠403Invalid API key

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/health'

Response Example

200 - Without a token, healthy

{
    "status": "healthy",
    "timestamp": "2026-09-01T14:30:00Z",
    "hostname": "core1.example.com",
    "app_version": "46.0.1234"
}

Modified at 2026-10-30 21:11:37

Get API version

Get access token