————-check add stuff————–

I2PControl API Dokumentation

I2PControl ist eine JSON-RPC 2.0 API, die mit dem I2P router (seit Version 0.9.39) mitgeliefert wird. Sie ermöglicht die authentifizierte Überwachung und Steuerung des routers über strukturierte JSON-Anfragen.

Standardpasswort: itoopie — dies ist die Werkseinstellung und sollte sofort geändert werden aus Sicherheitsgründen.

1. Übersicht & Zugriff

2. JSON-RPC Format

Alle Anfragen folgen der JSON-RPC 2.0 Struktur:

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "MethodName",
  "params": {
    /* named parameters */
  }
}

Eine erfolgreiche Antwort enthält ein result-Feld; bei einem Fehler wird ein error-Objekt zurückgegeben:

{
  "jsonrpc": "2.0",
  "id": "1",
  "result": { /* data */ }
}

oder

{
  "jsonrpc": "2.0",
  "id": "1",
  "error": {
    "code": -32001,
    "message": "Invalid password"
  }
}

3. Authentifizierungsablauf

Anfrage (Authentifizieren)

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "1",
        "method": "Authenticate",
        "params": {
          "API": 1,
          "Password": "itoopie"
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Erfolgreiche Antwort

{
  "jsonrpc": "2.0",
  "id": "1",
  "result": {
    "Token": "a1b2c3d4e5",
    "API": 1
  }
}

Sie müssen diesen Token in allen nachfolgenden Anfragen in den params einschließen.

4. Methoden & Endpunkte

4.1 RouterInfo

Ruft wichtige Telemetriedaten über den router ab.

Anfrage-Beispiel

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "2",
        "method": "RouterInfo",
        "params": {
          "Token": "a1b2c3d4e5",
          "i2p.router.version": "",
          "i2p.router.status": "",
          "i2p.router.net.status": "",
          "i2p.router.net.tunnels.participating": "",
          "i2p.router.net.bw.inbound.1s": "",
          "i2p.router.net.bw.outbound.1s": ""
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Antwortfelder (result) Laut der offiziellen Dokumentation (GetI2P): - i2p.router.status (String) — ein für Menschen lesbarer Status - i2p.router.uptime (long) — Millisekunden (oder String für ältere i2pd-Versionen) :contentReference[oaicite:0]{index=0} - i2p.router.version (String) — Versionszeichenkette :contentReference[oaicite:1]{index=1} - i2p.router.net.bw.inbound.1s, i2p.router.net.bw.inbound.15s (double) — eingehende Bandbreite in B/s :contentReference[oaicite:2]{index=2} - i2p.router.net.bw.outbound.1s, i2p.router.net.bw.outbound.15s (double) — ausgehende Bandbreite in B/s :contentReference[oaicite:3]{index=3} - i2p.router.net.status (long) — numerischer Statuscode (siehe Enum unten) :contentReference[oaicite:4]{index=4} - i2p.router.net.tunnels.participating (long) — Anzahl der teilnehmenden tunnel :contentReference[oaicite:5]{index=5} - i2p.router.netdb.activepeers, fastpeers, highcapacitypeers (long) — netDB Peer-Statistiken :contentReference[oaicite:6]{index=6} - i2p.router.netdb.isreseeding (boolean) — ob Reseed aktiv ist :contentReference[oaicite:7]{index=7} - i2p.router.netdb.knownpeers (long) — insgesamt bekannte Peers :contentReference[oaicite:8]{index=8}

Status Code Enum (i2p.router.net.status)

4.2 GetRate

Wird verwendet, um Ratenmetriken (z.B. Bandbreite, tunnel-Erfolg) über ein bestimmtes Zeitfenster abzurufen.

Anfrage-Beispiel

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "3",
        "method": "GetRate",
        "params": {
          "Token": "a1b2c3d4e5",
          "Stat": "bw.combined",
          "Period": 60000
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Beispielantwort

{
  "jsonrpc": "2.0",
  "id": "3",
  "result": {
    "Rate": 12345.67
  }
}

4.3 RouterManager

Administrative Aktionen durchführen.

Erlaubte Parameter / Methoden - Restart, RestartGraceful - Shutdown, ShutdownGraceful - Reseed, FindUpdates, Update :contentReference[oaicite:10]{index=10}

Anfrage-Beispiel

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "4",
        "method": "RouterManager",
        "params": {
          "Token": "a1b2c3d4e5",
          "Restart": true
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Erfolgreiche Antwort

{
  "jsonrpc": "2.0",
  "id": "4",
  "result": {
    "Restart": null
  }
}

4.4 NetworkSetting

Netzwerkkonfigurationsparameter abrufen oder festlegen (Ports, UPnP, Bandbreitenanteil, etc.)

Anfrage-Beispiel (aktuelle Werte abrufen)

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "5",
        "method": "NetworkSetting",
        "params": {
          "Token": "a1b2c3d4e5",
          "i2p.router.net.ntcp.port": null,
          "i2p.router.net.ssu.port": null,
          "i2p.router.net.bw.share": null,
          "i2p.router.net.upnp": null
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Beispielantwort

{
  "jsonrpc": "2.0",
  "id": "5",
  "result": {
    "i2p.router.net.ntcp.port": "1234",
    "i2p.router.net.ssu.port": "5678",
    "i2p.router.net.bw.share": "50",
    "i2p.router.net.upnp": "true",
    "SettingsSaved": true,
    "RestartNeeded": false
  }
}

Hinweis: i2pd-Versionen vor 2.41 können numerische Typen anstelle von Strings zurückgeben — Clients sollten beide verarbeiten können. :contentReference[oaicite:11]{index=11}

4.5 Erweiterte Einstellungen

Ermöglicht die Manipulation interner router-Parameter.

Anfrage-Beispiel

curl -s -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "6",
        "method": "AdvancedSettings",
        "params": {
          "Token": "a1b2c3d4e5",
          "Set": {
            "router.sharePercentage": "75",
            "i2np.flushInterval": "6000"
          }
        }
      }' \
  http://127.0.0.1:7657/jsonrpc/

Antwort-Beispiel

{
  "jsonrpc": "2.0",
  "id": "6",
  "result": {
    "Set": {
      "router.sharePercentage": "75",
      "i2np.flushInterval": "6000"
    }
  }
}

5. Fehlercodes

Standard JSON-RPC2 Fehlercodes

6. Verwendung und bewährte Praktiken

• Fügen Sie immer den Token-Parameter hinzu (außer bei der Authentifizierung).
• Ändern Sie das Standardpasswort (itoopie) bei der ersten Verwendung.
• Stellen Sie bei Java I2P sicher, dass die I2PControl-Webapp über WebApps aktiviert ist.
• Seien Sie auf geringfügige Abweichungen vorbereitet: einige Felder können je nach I2P-Version Zahlen oder Strings sein.
• Umbrechen Sie lange Status-Strings für eine anzeigefreundliche Ausgabe.