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:01:29

    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.

    Devices

    text
    openclaw devices

    Manage device pairing requests and device-scoped tokens.

    Commands

    text
    openclaw devices list

    List pending pairing requests and paired devices.

    text
    openclaw devices list openclaw devices list --json

    Pending request output shows the requested access next to the device's current approved access when the device is already paired. This makes scope/role upgrades explicit instead of looking like the pairing was lost.

    text
    openclaw devices remove <deviceId>

    Remove one paired device entry.

    When you are authenticated with a paired device token, non-admin callers can remove only their own device entry. Removing some other device requires

    text
    operator.admin
    .

    text
    openclaw devices remove <deviceId> openclaw devices remove <deviceId> --json

    text
    openclaw devices clear --yes [--pending]

    Clear paired devices in bulk.

    text
    openclaw devices clear --yes openclaw devices clear --yes --pending openclaw devices clear --yes --pending --json

    text
    openclaw devices approve [requestId] [--latest]

    Approve a pending device pairing request by exact

    text
    requestId
    . If
    text
    requestId
    is omitted or
    text
    --latest
    is passed, OpenClaw only prints the selected pending request and exits; rerun approval with the exact request ID after verifying the details.

    note

    If a device retries pairing with changed auth details (role, scopes, or public key), OpenClaw supersedes the previous pending entry and issues a new `requestId`. Run `openclaw devices list` right before approval to use the current ID.

    If the device is already paired and asks for broader scopes or a broader role, OpenClaw keeps the existing approval in place and creates a new pending upgrade request. Review the

    text
    Requested
    vs
    text
    Approved
    columns in
    text
    openclaw devices list
    or use
    text
    openclaw devices approve --latest
    to preview the exact upgrade before approving it.

    If the Gateway is explicitly configured with

    text
    gateway.nodes.pairing.autoApproveCidrs
    , first-time
    text
    role: node
    requests from matching client IPs can be approved before they appear in this list. That policy is disabled by default and never applies to operator/browser clients or upgrade requests.

    text
    openclaw devices approve openclaw devices approve <requestId> openclaw devices approve --latest

    text
    openclaw devices reject <requestId>

    Reject a pending device pairing request.

    text
    openclaw devices reject <requestId>

    text
    openclaw devices rotate --device <id> --role <role> [--scope <scope...>]

    Rotate a device token for a specific role (optionally updating scopes). The target role must already exist in that device's approved pairing contract; rotation cannot mint a new unapproved role. If you omit

    text
    --scope
    , later reconnects with the stored rotated token reuse that token's cached approved scopes. If you pass explicit
    text
    --scope
    values, those become the stored scope set for future cached-token reconnects. Non-admin paired-device callers can rotate only their own device token. The target token scope set must stay within the caller session's own operator scopes; rotation cannot mint or preserve a broader operator token than the caller already has.

    text
    openclaw devices rotate --device <deviceId> --role operator --scope operator.read --scope operator.write

    Returns rotation metadata as JSON. If the caller is rotating its own token while authenticated with that device token, the response also includes the replacement token so the client can persist it before reconnecting. Shared/admin rotations do not echo the bearer token.

    text
    openclaw devices revoke --device <id> --role <role>

    Revoke a device token for a specific role.

    Non-admin paired-device callers can revoke only their own device token. Revoking some other device's token requires

    text
    operator.admin
    . The target token scope set must also fit within the caller session's own operator scopes; pairing-only callers cannot revoke admin/write operator tokens.

    text
    openclaw devices revoke --device <deviceId> --role node

    Returns the revoke result as JSON.

    Common options

    • text
      --url <url>
      : Gateway WebSocket URL (defaults to
      text
      gateway.remote.url
      when configured).
    • text
      --token <token>
      : Gateway token (if required).
    • text
      --password <password>
      : Gateway password (password auth).
    • text
      --timeout <ms>
      : RPC timeout.
    • text
      --json
      : JSON output (recommended for scripting).

    warning

    When you set `--url`, the CLI does not fall back to config or environment credentials. Pass `--token` or `--password` explicitly. Missing explicit credentials is an error.

    Notes

    • Token rotation returns a new token (sensitive). Treat it like a secret.
    • These commands require
      text
      operator.pairing
      (or
      text
      operator.admin
      ) scope.
    • text
      gateway.nodes.pairing.autoApproveCidrs
      is an opt-in Gateway policy for fresh node device pairing only; it does not change CLI approval authority.
    • Token rotation and revocation stay inside the approved pairing role set and approved scope baseline for that device. A stray cached token entry does not grant a token-management target.
    • For paired-device token sessions, cross-device management is admin-only:
      text
      remove
      ,
      text
      rotate
      , and
      text
      revoke
      are self-only unless the caller has
      text
      operator.admin
      .
    • Token mutation is also caller-scope contained: a pairing-only session cannot rotate or revoke a token that currently carries
      text
      operator.admin
      or
      text
      operator.write
      .
    • text
      devices clear
      is intentionally gated by
      text
      --yes
      .
    • If pairing scope is unavailable on local loopback (and no explicit
      text
      --url
      is passed), list/approve can use a local pairing fallback.
    • text
      devices approve
      requires an explicit request ID before minting tokens; omitting
      text
      requestId
      or passing
      text
      --latest
      only previews the newest pending request.

    Token drift recovery checklist

    Use this when Control UI or other clients keep failing with

    text
    AUTH_TOKEN_MISMATCH
    or
    text
    AUTH_DEVICE_TOKEN_MISMATCH
    .

    1. Confirm current gateway token source:
    bash
    openclaw config get gateway.auth.token
    1. List paired devices and identify the affected device id:
    bash
    openclaw devices list
    1. Rotate operator token for the affected device:
    bash
    openclaw devices rotate --device <deviceId> --role operator
    1. If rotation is not enough, remove stale pairing and approve again:
    bash
    openclaw devices remove <deviceId> openclaw devices list openclaw devices approve <requestId>
    1. Retry client connection with the current shared token/password.

    Notes:

    • Normal reconnect auth precedence is explicit shared token/password first, then explicit
      text
      deviceToken
      , then stored device token, then bootstrap token.
    • Trusted
      text
      AUTH_TOKEN_MISMATCH
      recovery can temporarily send both the shared token and the stored device token together for the one bounded retry.

    Related:

    • Dashboard auth troubleshooting
    • Gateway troubleshooting

    Related

    • CLI reference
    • Nodes

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine