TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:03:00

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

    Use this file to discover all available pages before exploring further.

    Gateway-owned pairing

    In Gateway-owned pairing, the Gateway is the source of truth for which nodes are allowed to join. UIs (macOS app, future clients) are just frontends that approve or reject pending requests.

    Important: WS nodes use device pairing (role

    text
    node
    ) during
    text
    connect
    .
    text
    node.pair.*
    is a separate pairing store and does not gate the WS handshake. Only clients that explicitly call
    text
    node.pair.*
    use this flow.

    Concepts

    • Pending request: a node asked to join; requires approval.
    • Paired node: approved node with an issued auth token.
    • Transport: the Gateway WS endpoint forwards requests but does not decide membership. (Legacy TCP bridge support has been removed.)

    How pairing works

    1. A node connects to the Gateway WS and requests pairing.
    2. The Gateway stores a pending request and emits
      text
      node.pair.requested
      .
    3. You approve or reject the request (CLI or UI).
    4. On approval, the Gateway issues a new token (tokens are rotated on re‑pair).
    5. The node reconnects using the token and is now “paired”.

    Pending requests expire automatically after 5 minutes.

    CLI workflow (headless friendly)

    bash
    openclaw nodes pending openclaw nodes approve <requestId> openclaw nodes reject <requestId> openclaw nodes status openclaw nodes remove --node <id|name|ip> openclaw nodes rename --node <id|name|ip> --name "Living Room iPad"

    text
    nodes status
    shows paired/connected nodes and their capabilities.

    API surface (gateway protocol)

    Events:

    • text
      node.pair.requested
      — emitted when a new pending request is created.
    • text
      node.pair.resolved
      — emitted when a request is approved/rejected/expired.

    Methods:

    • text
      node.pair.request
      — create or reuse a pending request.
    • text
      node.pair.list
      — list pending + paired nodes (
      text
      operator.pairing
      ).
    • text
      node.pair.approve
      — approve a pending request (issues token).
    • text
      node.pair.reject
      — reject a pending request.
    • text
      node.pair.remove
      — remove a stale paired node entry.
    • text
      node.pair.verify
      — verify
      text
      { nodeId, token }
      .

    Notes:

    • text
      node.pair.request
      is idempotent per node: repeated calls return the same pending request.
    • Repeated requests for the same pending node also refresh the stored node metadata and the latest allowlisted declared command snapshot for operator visibility.
    • Approval always generates a fresh token; no token is ever returned from
      text
      node.pair.request
      .
    • Requests may include
      text
      silent: true
      as a hint for auto-approval flows.
    • text
      node.pair.approve
      uses the pending request's declared commands to enforce extra approval scopes:
      • commandless request:
        text
        operator.pairing
      • non-exec command request:
        text
        operator.pairing
        +
        text
        operator.write
      • text
        system.run
        /
        text
        system.run.prepare
        /
        text
        system.which
        request:
        text
        operator.pairing
        +
        text
        operator.admin

    warning

    Node pairing is a trust and identity flow plus token issuance. It does **not** pin the live node command surface per node.
    • Live node commands come from what the node declares on connect after the gateway's global node command policy (
      text
      gateway.nodes.allowCommands
      and
      text
      denyCommands
      ) is applied.
    • Per-node
      text
      system.run
      allow and ask policy lives on the node in
      text
      exec.approvals.node.*
      , not in the pairing record.

    Node command gating (2026.3.31+)

    warning

    **Breaking change:** Starting with `2026.3.31`, node commands are disabled until node pairing is approved. Device pairing alone is no longer enough to expose declared node commands.

    When a node connects for the first time, pairing is requested automatically. Until the pairing request is approved, all pending node commands from that node are filtered and will not execute. Once trust is established through pairing approval, the node's declared commands become available subject to the normal command policy.

    This means:

    • Nodes that were previously relying on device pairing alone to expose commands must now complete node pairing.
    • Commands queued before pairing approval are dropped, not deferred.

    Node event trust boundaries (2026.3.31+)

    warning

    **Breaking change:** Node-originated runs now stay on a reduced trusted surface.

    Node-originated summaries and related session events are restricted to the intended trusted surface. Notification-driven or node-triggered flows that previously relied on broader host or session tool access may need adjustment. This hardening ensures that node events cannot escalate into host-level tool access beyond what the node's trust boundary permits.

    Durable node presence updates follow the same identity boundary. The

    text
    node.presence.alive
    event is accepted only from authenticated node device sessions and updates pairing metadata only when the device/node identity is already paired. Self-declared
    text
    client.id
    values are not enough to write last-seen state.

    Auto-approval (macOS app)

    The macOS app can optionally attempt a silent approval when:

    • the request is marked
      text
      silent
      , and
    • the app can verify an SSH connection to the gateway host using the same user.

    If silent approval fails, it falls back to the normal “Approve/Reject” prompt.

    Trusted-CIDR device auto-approval

    WS device pairing for

    text
    role: node
    remains manual by default. For private node networks where the Gateway already trusts the network path, operators can opt in with explicit CIDRs or exact IPs:

    json5
    { gateway: { nodes: { pairing: { autoApproveCidrs: ["192.168.1.0/24"], }, }, }, }

    Security boundary:

    • Disabled when
      text
      gateway.nodes.pairing.autoApproveCidrs
      is unset.
    • No blanket LAN or private-network auto-approve mode exists.
    • Only fresh
      text
      role: node
      device pairing with no requested scopes is eligible.
    • Operator, browser, Control UI, and WebChat clients stay manual.
    • Role, scope, metadata, and public-key upgrades stay manual.
    • Same-host loopback trusted-proxy header paths are not eligible because that path can be spoofed by local callers.

    Metadata-upgrade auto-approval

    When an already paired device reconnects with only non-sensitive metadata changes (for example, display name or client platform hints), OpenClaw treats that as a

    text
    metadata-upgrade
    . Silent auto-approval is narrow: it applies only to trusted non-browser local reconnects that already proved possession of local or shared credentials, including same-host native app reconnects after OS version metadata changes. Browser/Control UI clients and remote clients still use the explicit re-approval flow. Scope upgrades (read to write/admin) and public key changes are not eligible for metadata-upgrade auto-approval — they stay as explicit re-approval requests.

    QR pairing helpers

    text
    /pair qr
    renders the pairing payload as structured media so mobile and browser clients can scan it directly.

    Deleting a device also sweeps any stale pending pairing requests for that device id, so

    text
    nodes pending
    does not show orphaned rows after a revoke.

    Locality and forwarded headers

    Gateway pairing treats a connection as loopback only when both the raw socket and any upstream proxy evidence agree. If a request arrives on loopback but carries

    text
    X-Forwarded-For
    /
    text
    X-Forwarded-Host
    /
    text
    X-Forwarded-Proto
    headers that point at a non-local origin, that forwarded-header evidence disqualifies the loopback locality claim. The pairing path then requires explicit approval instead of silently treating the request as a same-host connect. See Trusted Proxy Auth for the equivalent rule on operator auth.

    Storage (local, private)

    Pairing state is stored under the Gateway state directory (default

    text
    ~/.openclaw
    ):

    • text
      ~/.openclaw/nodes/paired.json
    • text
      ~/.openclaw/nodes/pending.json

    If you override

    text
    OPENCLAW_STATE_DIR
    , the
    text
    nodes/
    folder moves with it.

    Security notes:

    • Tokens are secrets; treat
      text
      paired.json
      as sensitive.
    • Rotating a token requires re-approval (or deleting the node entry).

    Transport behavior

    • The transport is stateless; it does not store membership.
    • If the Gateway is offline or pairing is disabled, nodes cannot pair.
    • If the Gateway is in remote mode, pairing still happens against the remote Gateway’s store.

    Related

    • Channel pairing
    • Nodes
    • Devices CLI

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine