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/info endpoint exposes metadata about the running HungerBridge instance: the bridge version, the platform it is running on (fabric or paper), and the Minecraft server version string. Use this endpoint to verify compatibility between your client code and the deployed bridge before making other API calls.

​
Request

Method: GET
Path: /v2/info

​
Headers

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

​
Configuration

This endpoint can be disabled in config.yaml under v2-endpoints.info. It is enabled by default. 
v2-endpoints:
  info: true
If v2-endpoints.info is set to false, the server returns a 403 Forbidden response.

​
Response

​
ok
boolean
required
Always true on success.
​
bridge
object
required
An object containing metadata about the HungerBridge instance and its host server.

​
Example Response

{
  "ok": true,
  "bridge": {
    "version": "2.1.0",
    "platform": "fabric",
    "minecraft": "1.21.1"
  }
}

​
Error Responses

Statuserror fieldCause
401unauthorizedMissing or incorrect X-Auth-Key header
403forbiddenEndpoint disabled via v2-endpoints.info: 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/info \
  -H "X-Auth-Key: your-auth-key"
The platform field is a reliable way to detect which backend is in use so that your client can account for platform-specific differences in endpoints such as /v2/tps.

Build docs developers (and LLMs) love

Get started for freeTalk to us