apiKeyFile

Protects an imhttp input with API key authentication using tokens listed in a file.

This parameter applies to imhttp: HTTP input module.

Name:

apiKeyFile

Scope:

input

Type:

string

Default:

none

Required?:

no

Introduced:

Not specified

Description

If set, imhttp reads one API key token per line from the specified file and accepts matching HTTP Authorization: ApiKey or X-API-Key credentials. Leading whitespace after ApiKey and X-API-Key is ignored.

Blank lines and lines starting with # are ignored.

If both basicAuthFile and apiKeyFile are configured for the same input, either authentication method is accepted.

Input usage

input(
    type="imhttp"
    endpoint="/ingest"
    apiKeyFile="/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.