Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/iFamishedX/HungerBridge/llms.txt

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

The /v2/status endpoint is a minimal liveness probe. It returns {"ok": true} as long as the HungerBridge HTTP server is up and the request passes authentication. Use it in monitoring pipelines, uptime checkers, or load balancers that need a lightweight signal that the server is alive — without carrying extra payload.

​
Request

Method: GET
Path: /v2/status

​
Headers

HeaderRequiredDescription
X-Auth-KeyYesAuthentication key from config.yaml → auth.key

​
Configuration

This endpoint can be disabled in config.yaml under v2-endpoints.status. It is enabled by default. 
v2-endpoints:
  status: true
If v2-endpoints.status is set to false, the server returns a 403 Forbidden response. Your monitoring checks should treat any non-200 response as a failure.

​
Response

​
ok
boolean
required
Always true on a successful 200 response. This is the sole meaningful signal — if the server is not running, no response is returned at all; if the endpoint is disabled or auth fails, a non-200 status is returned.

​
Example Response

{
  "ok": true
}

​
Error Responses

Statuserror fieldCause
401unauthorizedMissing or incorrect X-Auth-Key header
403forbiddenEndpoint disabled via v2-endpoints.status: false
405method_not_allowedRequest method was not GET
{
  "ok": false,
  "error": "unauthorized",
  "message": "Invalid X-Auth-Key"
}

​
curl Example

curl -s -X GET http://localhost:30007/v2/status \
  -H "X-Auth-Key: your-auth-key"
/v2/status intentionally carries no server metrics. If you need version information alongside your liveness check, see GET /v2/info. If you need TPS data, see GET /v2/tps.

Build docs developers (and LLMs) love

Get started for freeTalk to us