GET /status – ferrixx API

API Status

Gibt den aktuellen Status der API sowie Statistiken zurück.

GET /v1/status status

Authentifizierung

Berechtigung status oder * erforderlich.

Parameter

Keine Parameter.

Beispiel-Request

curl -H "X-API-Key: apk_dein_key" \
     https://api.ferrixx.de/v1/status

Beispiel-Antwort

{
  "success": true,
  "message": "OK",
  "data": {
    "api": {
      "name": "ferrixx API",
      "version": "1.0.0",
      "status": "operational"
    },
    "stats": {
      "active_api_keys": 3,
      "configured_servers": 5,
      "total_ping_checks": 142
    },
    "endpoints": {
      "GET /v1/status": "API status & stats",
      "GET /v1/ping": "Ping all configured servers",
      "GET /v1/ping?id=1": "Ping specific configured server",
      "GET /v1/ping?host=&port=&type=": "Ping custom host (requires ping.custom)",
      "GET /v1/minecraft?host=&port=": "Minecraft server status"
    },
    "authenticated_as": "Mein API Key"
  },
  "timestamp": "2026-06-01T12:00:00+00:00"
}