#OpenClaw Documentation Single Markdown

Name: OpenClaw Documentation Dataset
Creator: OpenClaw

OpenClaw is a developer tool with comprehensive developer documentation. The full documentation spans 365 pages and 1.5 MB, last crawled 1 week ago. This page reflects the latest available version.

OpenClaw / latest

365 pages·1.44 MB·updated Mar 23, 2026

### preview

----
url: https://docs.openclaw.ai/gateway/health
----

# Health Checks - OpenClaw

## [](#health-checks-cli)Health Checks (CLI)

Short guide to verify channel connectivity without guessing.

## [](#quick-checks)Quick checks

* `openclaw status` — local summary: gateway reachability/mode, update hint, linked channel auth age, sessions + recent activity.
* `openclaw status --all` — full local diagnosis (read-only, color, safe to paste for debugging).
* `openclaw status --deep` — also probes the running Gateway (per-channel probes when supported).
* `openclaw health --json` — asks the running Gateway for a full health snapshot (WS-only; no direct Baileys socket).
* Send `/status` as a standalone message in WhatsApp/WebChat to get a status reply without invoking the agent.
* Logs: tail `/tmp/openclaw/openclaw-*.log` and filter for `web-heartbeat`, `web-reconnect`, `web-auto-reply`, `web-inbound`.

## [](#deep-diagnostics)Deep diagnostics

* Creds on disk: `ls -l ~/.openclaw/credentials/whatsapp/<accountId>/creds.json` (mtime should be recent).
* Session store: `ls -l ~/.openclaw/agents/<agentId>/sessions/sessions.json` (path can be overridden in config). Count and recent recipients are surfaced via `status`.
* Relink flow: `openclaw channels logout && openclaw channels login --verbose` when status codes 409–515 or `loggedOut` appear in logs. (Note: the QR login flow auto-restarts once for status 515 after pairing.)

## [](#health-monitor-config)Health monitor config

* `gateway.channelHealthCheckMinutes`: how often the gateway checks channel health. Default: `5`. Set `0` to disable health-monitor restarts globally.
* `gateway.channelStaleEventThresholdMinutes`: how long a connected channel can stay idle before the health monitor treats it as stale and restarts it. Default: `30`. Keep this greater than or equal to `gateway.channelHealthCheckMinutes`.
* `gateway.channelMaxRestartsPerHour`: rolling one-hour cap for health-monitor restarts per channel/account. Default: `10`.
* `channels.<provider>.healthMonitor.enabled`: disable health-monitor restarts for a specific channel while leaving global monitoring enabled.
* `channels.<provider>.accounts.<accountId>.healthMonitor.enabled`: multi-account override that wins over the channel-level setting.
* These per-channel overrides apply to the built-in channel monitors that expose them today: Discord, Google Chat, iMessage, Microsoft Teams, Signal, Slack, Telegram, and WhatsApp.

## [](#when-something-fails)When something fails

* `logged out` or status 409–515 → relink with `openclaw channels logout` then `openclaw channels login`.
* Gateway unreachable → start it: `openclaw gateway --port 18789` (use `--force` if the port is busy).
* No inbound messages → confirm linked phone is online and the sender is allowed (`channels.whatsapp.allowFrom`); for group chats, ensure allowlist + mention rules match (`channels.whatsapp.groups`, `agents.list[].groupChat.mentionPatterns`).

## [](#dedicated-“health”-command)Dedicated “health” command

`openclaw health --json` asks the running Gateway for its health snapshot (no direct channel sockets from the CLI). It reports linked creds/auth age when available, per-channel probe summaries, session-store summary, and a probe duration. It exits non-zero if the Gateway is unreachable or the probe fails/timeouts. Use `--timeout <ms>` to override the 10s default.

----
url: https://docs.openclaw.ai/cli/devices
----

# devices - OpenClaw

## [](#openclaw-devices)`openclaw devices`

Manage device pairing requests and device-scoped tokens.

## [](#commands)Commands

### [](#openclaw-devices-list)`openclaw devices list`

List pending pairing requests and paired devices.

```
openclaw devices list
openclaw devices list --json
```

Pending request output includes the requested role and scopes so approvals can be reviewed before you approve.

### [](#openclaw-devices-remove-<deviceid>)`openclaw devices remove <deviceId>`

Remove one paired device entry.

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

### [](#openclaw-devices-clear-yes--pending)`openclaw devices clear --yes [--pending]`

Clear paired devices in bulk.

```
openclaw devices clear --yes
openclaw devices clear --yes --pending
openclaw devices clear --yes --pending --json
```

### [](#openclaw-devices-approve-requestid--latest)`openclaw devices approve [requestId] [--latest]`

Approve a pending device pairing request. If `requestId` is omitted, OpenClaw automatically approves the most recent pending request. Note: if a device retries pairing with changed auth details (role/scopes/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.

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

### [](#openclaw-devices-reject-<requestid>)`openclaw devices reject <requestId>`

Reject a p

##About OpenClaw

OpenClaw is a personal AI assistant that runs on your own computer, keeping your data private and enabling private automation across platforms. It can interact through popular chat apps (WhatsApp, Telegram, Discord, iMessage) and control your system, including browsing the web, reading and writing files, and running commands. It supports persistent memory to remember preferences and context, and a skills plugins ecosystem to extend capabilities. The official documentation covers 365 pages of technical reference. This entry reflects the current stable release.

category:[Second Brain & Knowledge Management]

source: https://docs.openclaw.ai/