Admin-HTTP-RPC-Plugin

• POST /api/v1/admin/rpc
• derselbe Listener wie das Gateway: http://<gateway-host>:<port>/api/v1/admin/rpc

​

Bevor Sie es aktivieren

• Dem Aufrufer wird vertraut, das Gateway zu betreiben.
• Der Aufrufer kann den WebSocket-RPC-Client nicht verwenden.
• Die Route ist nur über Loopback, ein Tailnet oder einen privaten authentifizierten Ingress erreichbar.
• Sie haben die zulässigen Methoden geprüft, und sie passen zu der Automatisierung, die Sie ausführen möchten.

​

Aktivieren

openclaw plugins enable admin-http-rpc
openclaw gateway restart

{
  plugins: {
    entries: {
      "admin-http-rpc": { enabled: true },
    },
  },
}

openclaw plugins disable admin-http-rpc
openclaw gateway restart

​

Route überprüfen

curl -sS http://<gateway-host>:<port>/api/v1/admin/rpc \
  -H 'Authorization: Bearer <gateway-token>' \
  -H 'Content-Type: application/json' \
  -d '{"method":"health","params":{}}'

{
  "id": "generated-request-id",
  "ok": true,
  "payload": {
    "status": "ok"
  }
}

​

Authentifizierung

• Shared-Secret-Authentifizierung (gateway.auth.mode="token" oder "password"): Authorization: Bearer <token-or-password>
• vertrauenswürdige identitätstragende HTTP-Authentifizierung (gateway.auth.mode="trusted-proxy"): Leiten Sie über den konfigurierten identitätsbewussten Proxy weiter und lassen Sie ihn die erforderlichen Identitäts-Header einfügen
• offene Authentifizierung über privaten Ingress (gateway.auth.mode="none"): kein Authentifizierungs-Header erforderlich

​

Sicherheitsmodell

• Das Aktivieren des Plugins bietet absichtlich Zugriff auf die zugelassenen Admin-RPC-Methoden unter /api/v1/admin/rpc.
• Das Plugin deklariert den reservierten Manifest-Vertrag contracts.gatewayMethodDispatch: ["authenticated-request"], damit seine über Gateway authentifizierte HTTP-Route Control-Plane-Methoden im Prozess dispatchen kann.
• Shared-Secret-Bearer-Authentifizierung weist den Besitz des Gateway-Operator-Geheimnisses nach.
• Für token- und password-Authentifizierung werden engere x-openclaw-scopes-Header ignoriert, und die normalen vollständigen Operator-Standards werden wiederhergestellt.
• Vertrauenswürdige identitätstragende HTTP-Modi berücksichtigen x-openclaw-scopes, wenn vorhanden.
• gateway.auth.mode="none" bedeutet, dass diese Route nicht authentifiziert ist, wenn das Plugin aktiviert ist. Verwenden Sie dies nur hinter einem privaten Ingress, dem Sie vollständig vertrauen.
• Anfragen werden nach bestandener Authentifizierung der Plugin-Route über dieselben Gateway-Methodenhandler und Scope-Prüfungen wie WebSocket-RPC dispatcht.
• Halten Sie diese Route auf Loopback, Tailnet oder einem privaten vertrauenswürdigen Ingress. Stellen Sie sie nicht direkt dem öffentlichen Internet bereit.
• Plugin-Manifest-Verträge sind keine Sandbox. Sie verhindern die versehentliche Nutzung reservierter SDK-Helfer; vertrauenswürdige Plugins laufen dennoch im Gateway-Prozess.

​

Anfrage

POST /api/v1/admin/rpc
Authorization: Bearer <gateway-token>
Content-Type: application/json

{
  "id": "optional-request-id",
  "method": "health",
  "params": {}
}

• id (String, optional): wird in die Antwort kopiert. Eine UUID wird generiert, wenn es weggelassen wird.
• method (String, erforderlich): zulässiger Gateway-Methodenname.
• params (beliebig, optional): methodenspezifische Parameter.

​

Antwort

{
  "id": "optional-request-id",
  "ok": true,
  "payload": {}
}

{
  "id": "optional-request-id",
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "bad params"
  }
}

​

Zulässige Methoden

• Discovery: commands.list Gibt die von diesem Plugin zugelassenen HTTP-RPC-Methodennamen zurück.
• Gateway: health, status, logs.tail, usage.status, usage.cost, gateway.restart.request
• Konfiguration: config.get, config.schema, config.schema.lookup, config.set, config.patch, config.apply
• Kanäle: channels.status, channels.start, channels.stop, channels.logout
• Web: web.login.start, web.login.wait
• Modelle: models.list, models.authStatus
• Agents: agents.list, agents.create, agents.update, agents.delete
• Freigaben: exec.approvals.get, exec.approvals.set, exec.approvals.node.get, exec.approvals.node.set
• Cron: cron.status, cron.list, cron.get, cron.runs, cron.add, cron.update, cron.remove, cron.run
• Geräte: device.pair.list, device.pair.approve, device.pair.reject, device.pair.remove
• Nodes: node.list, node.describe, node.pair.list, node.pair.approve, node.pair.reject, node.pair.remove, node.rename
• Aufgaben: tasks.list, tasks.get, tasks.cancel
• Diagnose: doctor.memory.status, update.status

​

WebSocket-Vergleich

​

Fehlerbehebung

​

Verwandte Themen

• Operator-Scopes
• Gateway-Sicherheit
• Remote-Zugriff
• Plugin-Manifest
• SDK-Unterpfade