एडमिन HTTP RPC Plugin

​

इसे सक्षम करने से पहले

• कॉलर Gateway को संचालित करने के लिए विश्वसनीय है।
• कॉलर WebSocket RPC क्लाइंट का उपयोग नहीं कर सकता।
• रूट केवल लूपबैक, टेलनेट या निजी प्रमाणीकृत इनग्रेस पर पहुँच योग्य है।
• आपने अनुमत विधियों की समीक्षा की है और वे उस ऑटोमेशन से मेल खाती हैं जिसे आप चलाने वाले हैं।

​

सक्षम करें

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

​

रूट सत्यापित करें

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"
  }
}

​

प्रमाणीकरण

• साझा-गुप्त प्रमाणीकरण (gateway.auth.mode="token" या "password"): Authorization: Bearer <token-or-password>
• विश्वसनीय पहचान-युक्त HTTP प्रमाणीकरण (gateway.auth.mode="trusted-proxy"): कॉन्फ़िगर किए गए पहचान-जागरूक प्रॉक्सी के माध्यम से रूट करें और उसे आवश्यक पहचान हेडर इंजेक्ट करने दें
• निजी-इनग्रेस खुला प्रमाणीकरण (gateway.auth.mode="none"): किसी प्रमाणीकरण हेडर की आवश्यकता नहीं

​

सुरक्षा मॉडल

• Plugin को सक्षम करना जानबूझकर /api/v1/admin/rpc पर अनुमत-सूचीबद्ध एडमिन RPC विधियों की पहुँच प्रदान करता है।
• Plugin आरक्षित contracts.gatewayMethodDispatch: ["authenticated-request"] मैनिफ़ेस्ट अनुबंध घोषित करता है, जो इसके Gateway-प्रमाणीकृत HTTP रूट को उसी प्रक्रिया में कंट्रोल-प्लेन विधियाँ डिस्पैच करने देता है। यह सैंडबॉक्स नहीं है: अनुबंध आरक्षित SDK हेल्पर के आकस्मिक उपयोग को रोकता है, लेकिन विश्वसनीय Plugin फिर भी Gateway प्रक्रिया में चलते हैं।
• साझा-गुप्त बेयरर प्रमाणीकरण (token/password मोड) Gateway ऑपरेटर गुप्त के स्वामित्व को प्रमाणित करता है; उस पथ पर अधिक सीमित x-openclaw-scopes हेडर अनदेखे किए जाते हैं और सामान्य पूर्ण ऑपरेटर डिफ़ॉल्ट पुनर्स्थापित किए जाते हैं।
• विश्वसनीय पहचान-युक्त HTTP प्रमाणीकरण (trusted-proxy मोड) उपस्थित होने पर x-openclaw-scopes का सम्मान करता है।
• gateway.auth.mode="none" का अर्थ है कि Plugin सक्षम होने पर यह रूट अप्रमाणीकृत है। इसका उपयोग केवल ऐसे निजी इनग्रेस के पीछे करें जिस पर आपको पूर्ण विश्वास हो।
• Plugin रूट प्रमाणीकरण पास होने के बाद, अनुरोध उन्हीं Gateway विधि हैंडलर और स्कोप जाँचों के माध्यम से डिस्पैच होते हैं जिनका उपयोग WebSocket RPC करता है।
• तैयार निलंबन लीज़ के दौरान रूट पहुँच योग्य बना रहता है। सीमित अनुरोध सत्यापन और स्थानीय commands.list डिस्कवरी प्रतिक्रिया उपलब्ध रहती है। Gateway में डिस्पैच की जाने वाली विधियों में से, प्रवेश बंद होने पर केवल gateway.suspend.prepare, gateway.suspend.status और gateway.suspend.resume चल सकती हैं; अन्य अनुमत-सूचीबद्ध विधियाँ सामान्य पुनः प्रयास योग्य Gateway UNAVAILABLE प्रतिक्रिया लौटाती हैं।
• इस रूट को लूपबैक, टेलनेट या निजी विश्वसनीय इनग्रेस पर रखें। इसे सीधे सार्वजनिक इंटरनेट पर उजागर न करें। जब कॉलर विश्वास सीमाओं को पार करते हों, तो अलग-अलग Gateway का उपयोग करें।

​

अनुरोध

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

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

• id (स्ट्रिंग, वैकल्पिक): प्रतिक्रिया में कॉपी किया जाता है। छोड़े जाने पर एक UUID जनरेट किया जाता है।
• method (स्ट्रिंग, आवश्यक): अनुमत Gateway विधि का नाम।
• params (कोई भी, वैकल्पिक): विधि-विशिष्ट पैरामीटर।

​

प्रतिक्रिया

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

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

​

अनुमत विधियाँ

• डिस्कवरी: commands.list इस Plugin द्वारा अनुमत HTTP RPC विधि नाम लौटाता है।
• Gateway: health, status, logs.tail, usage.status, usage.cost, gateway.restart.request, gateway.suspend.prepare, gateway.suspend.status, gateway.suspend.resume
• कॉन्फ़िगरेशन: config.get, config.schema, config.schema.lookup, config.set, config.patch, config.apply
• चैनल: channels.status, channels.start, channels.stop, channels.logout
• वेब: web.login.start, web.login.wait
• मॉडल: models.list, models.authStatus
• एजेंट: agents.list, agents.create, agents.update, agents.delete
• अनुमोदन: 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
• डिवाइस: device.pair.list, device.pair.approve, device.pair.reject, device.pair.remove
• Node: node.list, node.describe, node.pair.list, node.pair.approve, node.pair.reject, node.pair.remove, node.rename
• कार्य: tasks.list, tasks.get, tasks.cancel
• निदान: doctor.memory.status, update.status

​

WebSocket तुलना

​

समस्या निवारण

​

संबंधित

• ऑपरेटर स्कोप
• Gateway सुरक्षा
• दूरस्थ पहुँच
• Plugin मैनिफ़ेस्ट
• SDK उपपथ