Reference
Use Reference to look up commands and flags, HTTP operations and permissions, request and response fields, PostgreSQL tables, and environment variables for the OpenClaw Control Plane (OCC).
Cheat sheets
- API: public methods and what they do, by entity.
- Permissions: all IAM actions, resources, and access scopes.
- Database entities: PostgreSQL tables, their purpose, and their columns.
- Environment variables: variables by topic.
CLI
Use occ from a terminal to manage an Installation, Namespaces, Configurations,
and Agents. Start with CLI setup to install it, connect, and
make your first request. The command reference lists the available
commands, flags, and output formats.
HTTP API
Use the HTTP API from automation or when you need an operation the CLI does not expose. The HTTP API quickstart makes authenticated requests and explains the responses. The API reference lists exact paths, schemas, permissions, and error codes. It is generated from the checked-in OpenAPI contract.
Metrics
The OCC metrics reference defines application and process metrics and the private listener configuration.
PostgreSQL authentication
The auth binding defines the package interface and pool/schema ownership for controller authentication.
Related
- Topics explains what product features do; Configuration and Installation settings cover supported configuration.
- Authentication and authorization explain which credentials and permissions requests need.
- Agent Presets defines reusable launch settings, variables, and CRUD permissions.
- Agent native admin UI covers trusted operator access, exact Agent authorization, and routing limits.
- Integrations covers named Drivers and Backends.
- Contribute covers development; see API generation checks when changing routes or schemas.