Settings API - Kafka Consumer Header Capturing Settings schema table

  • Published Sep 25, 2025

Kafka Consumer Header Capturing Settings (builtin:kafka.capturing)

Enables capturing of Kafka consumer headers. Only supported by the Java code module at the moment.

Schema IDSchema groupsScope
builtin:kafka.capturing-
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:kafka.capturing
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:kafka.capturing
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:kafka.capturing

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Kafka Consumer Header Capturing Rules
consumerHeadersToCapture		ConsumerHeaderCapturingRule[]

Rule to capture a Kafka Header when consuming

required
The ConsumerHeaderCapturingRule object
PropertyTypeDescriptionRequired
Consumer header name
name		text-required
Kafka Header Format
format		enum
  • UTF8
required