Admin HTTP RPC Plugin

• POST /api/v1/admin/rpc
• тот же слушатель, что и Gateway: http://<gateway-host>:<port>/api/v1/admin/rpc

​

Перед включением

• Вызывающему клиенту доверено управление Gateway.
• Вызывающий клиент не может использовать WebSocket RPC-клиент.
• Маршрут доступен только на loopback, в tailnet или через приватный аутентифицированный вход.
• Вы проверили разрешенные методы, и они соответствуют автоматизации, которую вы планируете запускать.

​

Включение

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 намеренно предоставляет доступ к разрешенным admin RPC-методам по адресу /api/v1/admin/rpc.
• Plugin объявляет зарезервированный контракт манифеста contracts.gatewayMethodDispatch: ["authenticated-request"], чтобы его HTTP-маршрут с аутентификацией Gateway мог диспетчеризовать методы плоскости управления внутри процесса.
• Bearer-аутентификация с общим секретом подтверждает владение операторским секретом gateway.
• Для аутентификации token и password более узкие заголовки x-openclaw-scopes игнорируются, а обычные полные операторские значения по умолчанию восстанавливаются.
• Доверенные HTTP-режимы с удостоверением учитывают x-openclaw-scopes, когда они присутствуют.
• gateway.auth.mode="none" означает, что этот маршрут не аутентифицирован, если plugin включен. Используйте это только за приватным входом, которому вы полностью доверяете.
• После прохождения аутентификации маршрута plugin запросы диспетчеризуются через те же обработчики методов Gateway и проверки областей доступа, что и WebSocket RPC.
• Держите этот маршрут на loopback, в tailnet или за приватным доверенным входом. Не открывайте его напрямую в публичный интернет.
• Контракты манифеста plugin не являются песочницей. Они предотвращают случайное использование зарезервированных вспомогательных средств SDK; доверенные plugins все равно выполняются в процессе 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 Возвращает имена методов HTTP RPC, разрешенные этим plugin.
• gateway: health, status, logs.tail, usage.status, usage.cost, gateway.restart.request
• конфигурация: 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.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