# apikey

Supplies the value for the `Authorization: ApiKey` HTTP header.

This parameter applies to omelasticsearch: Elasticsearch Output Module.

Name:

  apikey

Scope:

  action

Type:

  word

Default:

  action=none

Required?:

  no

Introduced:

  8.2406.0

## Description

Accepts the API key material expected by Elasticsearch’s `ApiKey` authentication scheme. The configured value is appended to the `Authorization: ApiKey` header without modification, so provide the base64-encoded `<id>:<api_key>` string exactly as documented by Elasticsearch.

The API key setting cannot be combined with uid or pwd.

## Action usage

    action(type="omelasticsearch" apikey="...")

## See also

See also omelasticsearch: Elasticsearch Output Module.

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

Contributing: Source & docs: rsyslog source project

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