Check API health

GET

/health

Last modified:2026-10-07 23:39:37

OperationId:GetHealthStatusAPI

Checks the dependencies of the server that answered: the cache, every configured database connection, and the message bus. Load balancers and monitoring services can call it without a token.

Without a token, the response carries only status, timestamp, hostname, and app_version. With a valid token it also carries environment, php_version, and checks, the result of each dependency. No token is needed. You can still send one (a bearer access token, an API key, or the ns_access_token cookie) to get the longer response. Any valid token works, whatever its scope. A token that is sent but is invalid or expired is refused with 401, and an API key that is not valid with 403; you do not get the shorter response instead.

The HTTP status is always 200. Read status: healthy means every check passed, and degraded means at least one failed. Results are cached for 15 seconds per server, so a failure can take up to 15 seconds to show, and repeated calls in that window do not repeat the checks. The X-Health-Cache response header is hit when the result came from that cache and miss when it was just computed. Takes no parameters.

Request

None

Responses

🟢200OK

application/json

The health report. The HTTP status is 200 whether the server is healthy or degraded.

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-07 23:39:37

Get API version

Get access token