Sozu Command API

The Sozu Command API provides programmatic control of the Sōzu HTTP reverse proxy at runtime. External tools communicate with the Sozu main process through a secure Unix socket using a protobuf-based binary protocol (IPC). The sozu-command-lib crate ships the protobuf schema, configuration parser, replicated state, channels, and file descriptor passing helpers. This enables dynamic cluster configuration, certificate management, and backend routing changes without restarts.

API entry from apis.yml

apis.yml Raw ↑
aid: sozu:sozu-command-api
name: Sozu Command API
description: The Sozu Command API provides programmatic control of the Sōzu HTTP reverse proxy at runtime.
  External tools communicate with the Sozu main process through a secure Unix socket using a protobuf-based
  binary protocol (IPC). The sozu-command-lib crate ships the protobuf schema, configuration parser, replicated
  state, channels, and file descriptor passing helpers. This enables dynamic cluster configuration, certificate
  management, and backend routing changes without restarts.
humanURL: https://docs.sozu.io/
baseURL: https://github.com/sozu-proxy/sozu
tags:
- Proxy
- Command API
- Protobuf
- Runtime Configuration
properties:
- type: Documentation
  url: https://docs.sozu.io/
- type: GitHub
  url: https://github.com/sozu-proxy/sozu
- type: Getting Started
  url: https://docs.sozu.io/getting-started/
- type: Configuration
  url: https://github.com/sozu-proxy/sozu/blob/main/doc/configure.md
- type: How To Use
  url: https://github.com/sozu-proxy/sozu/blob/main/doc/how_to_use.md
- type: JSON Schema
  url: https://raw.githubusercontent.com/api-evangelist/sozu/refs/heads/main/json-schema/sozu-cluster-schema.json
- type: JSON Schema
  url: https://raw.githubusercontent.com/api-evangelist/sozu/refs/heads/main/json-schema/sozu-frontend-schema.json