HTTP Receiver Settings

Download PDF

LogZilla HTTP Receiver module settings for the /incoming endpoint, covering access tokens, authentication headers, and interactive API docs

HTTP Receiver Settings

HTTP Receiver module settings are available in the web interface. UI fields map to underlying settings and behaviors.

For how to send events over HTTP and verify ingestion, see HTTP Event Receiver. For relay-side (sender) configuration, see Syslog Relays.

Where HTTP events are received

  • External clients send to the configured HTTP/HTTPS port on the LogZilla host at path /incoming.
  • Internally, the HTTP Receiver serves endpoints under that path. The reverse proxy forwards /incoming to the receiver.
  • Interactive API docs are provided at /incoming/docs.
  • For endpoint reference and the OpenAPI schema, see HTTP Event Receiver.

Authentication (access tokens)

The HTTP Receiver accepts any of the following:

  • Authorization: token <YOUR_TOKEN> header
  • X-LZ-Access-Key: <YOUR_TOKEN> header
  • AUTHTOKEN=<YOUR_TOKEN> query parameter

Tokens are created and managed with the logzilla authtoken command or the /api/authtokens API; the token value is shown once, when the token is created. See Getting Started for how to create a token. The receiver accepts every active token, and a token created or revoked through either path is picked up without a restart.

Settings

  • HTTP Receiver Workers Number → HTTP_RECEIVER_WORKERS_NUM
    • Number of worker processes the receiver runs.
  • HTTP Receiver Show Access Logs → HTTP_RECEIVER_SHOW_ACCESS_LOGS
    • Enables HTTP access logging for the receiver.
  • HTTP Receiver Log Invalid Request → HTTP_RECEIVER_LOG_INVALID_REQUEST
    • When an ingest request is invalid (for example, a 422 response), logs a short diagnostic dump to aid troubleshooting. Disable in high-volume environments if logging is too chatty.

Notes

  • Listener ports are set in Front settings (HTTP/HTTPS). The HTTP Receiver does not have its own public port; it is exposed at /incoming on the UI/API port.
  • If configuration changes do not take effect automatically, restart the module:
bash
logzilla restart -c httpreceiver

Related topics

HTTP Receiver Settings | LogZilla Documentation