healthCheckApiKeyFile

Protects the imhttp health check endpoint with API key authentication.

This parameter applies to imhttp: HTTP input module.

Name:

healthCheckApiKeyFile

Scope:

module

Type:

string

Default:

none

Required?:

no

Introduced:

Not specified

Description

If set, the health check endpoint accepts matching API key tokens from a file. Accepted request headers are Authorization: ApiKey and X-API-Key. Leading whitespace after the header scheme is ignored.

Blank lines and lines starting with # are ignored.

Module usage

module(
    load="imhttp"
    healthCheckApiKeyFile="/etc/rsyslog/api-keys.txt"
)

See also

See also imhttp: HTTP input module.

---

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2026 Rainer Gerhards and others. Licensed under the Apache License 2.0.