Settings API - Ingest sources configuration schema table

  • Published Aug 25, 2025

Ingest sources configuration (builtin:openpipeline.user.events.ingest-sources)

Contains configuration of ingest sources

Schema IDSchema groupsScope
builtin:openpipeline.user.events.ingest-sources
  • group:openpipeline.all.ingest-sources
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.user.events.ingest-sources
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:openpipeline.user.events.ingest-sources
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.user.events.ingest-sources

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
Endpoint display name
displayName		text-required
Source Type
sourceType		enum
  • http
  • extension
required
Source
source		text-required
Endpoint segment
pathSegment		text-required
Default Bucket
defaultBucket		text-optional
Enabled
enabled		boolean-required
Static routing of endpoint
staticRouting		StaticRouting-optional
Processing stage
processing		Stage-optional
The StaticRouting object
PropertyTypeDescriptionRequired
Pipeline Type
pipelineType		enum
  • custom
  • builtin
required
Pipeline ID
pipelineId		setting-required
Builtin Pipeline ID
builtinPipelineId		text-required
The Stage object
PropertyTypeDescriptionRequired
Processors of stage
processors		Processor[]-required
The Processor object
PropertyTypeDescriptionRequired
Processor identifier
id		text-required
Type
type		enum

Processor type

  • fieldsAdd
  • fieldsRemove
  • fieldsRename
  • dql
  • technology
  • drop
  • bucketAssignment
  • noStorage
  • securityContext
  • counterMetric
  • samplingAwareCounterMetric
  • valueMetric
  • histogramMetric
  • samplingAwareValueMetric
  • samplingAwareHistogramMetric
  • davis
  • bizevent
  • sdlcEvent
  • azureLogForwarding
  • securityEvent
  • costAllocation
  • productAllocation
  • smartscapeNode
  • smartscapeEdge
required
Matcher (DQL)
matcher		text

See our documentation

required
Description
description		text-required
Sample data
sampleData		text-optional
Enabled
enabled		boolean-required
DQL processor attributes
dql		DqlAttributes-required
Fields add processor attributes
fieldsAdd		FieldsAddAttributes-required
Fields rename processor attributes
fieldsRename		FieldsRenameAttributes-required
Fields remove processor attributes
fieldsRemove		FieldsRemoveAttributes-required
Technology processor attributes
technology		TechnologyAttributes-required
Bucket assignment processor attributes
bucketAssignment		BucketAssignmentAttributes-required
Security context processor attributes
securityContext		SecurityContextAttributes-required
Counter metric processor attributes
counterMetric		CounterMetricAttributes-required
Sampling-aware counter metric processor attributes
samplingAwareCounterMetric		SamplingAwareCounterMetricAttributes-required
Value metric processor attributes
valueMetric		ValueMetricAttributes-required
Histogram metric processor attributes
histogramMetric		HistogramMetricAttributes-required
Sampling aware value metric processor attributes
samplingAwareValueMetric		SamplingAwareValueMetricAttributes-required
Sampling aware histogram metric processor attributes
samplingAwareHistogramMetric		SamplingAwareHistogramMetricAttributes-required
Davis event extraction processor attributes
davis		DavisAttributes-required
Bizevent extraction processor attributes
bizevent		BizeventAttributes-required
SdlcEvent extraction processor attributes
sdlcEvent		SdlcEventAttributes-required
Smartscape node extraction processor attributes
smartscapeNode		SmartscapeNodeAttributes-required
Smartscape edge extraction processor attributes
smartscapeEdge		SmartscapeEdgeAttributes-required
Azure log forwarding processor attributes
azureLogForwarding		AzureLogForwardingAttributes-required
Security event extraction processor attributes
securityEvent		SecurityEventAttributes-required
Cost allocation processor attributes
costAllocation		CostAllocationAttributes-required
Product allocation processor attributes
productAllocation		ProductAllocationAttributes-required
The DqlAttributes object
PropertyTypeDescriptionRequired
DQL script
script		text-required
The FieldsAddAttributes object
PropertyTypeDescriptionRequired
Fields to Add
fields		FieldsAddAttributesEntry[]-required
The FieldsRenameAttributes object
PropertyTypeDescriptionRequired
Fields to rename
fields		FieldsRenameAttributesEntry[]-required
The FieldsRemoveAttributes object
PropertyTypeDescriptionRequired
Fields to remove
fields		set-required
The TechnologyAttributes object
PropertyTypeDescriptionRequired
Custom matcher
customMatcher		text

Custom matching condition which should be used instead of technology matcher.

optional
Technology ID
technologyId		text-required
The BucketAssignmentAttributes object
PropertyTypeDescriptionRequired
Bucket name
bucketName		text-required
The SecurityContextAttributes object
PropertyTypeDescriptionRequired
Security context value assignment
value		GenericValueAssignment-required
The CounterMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
The SamplingAwareCounterMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
Sampling
sampling		enum
  • disabled
  • enabled
optional
Aggregation
aggregation		enum
  • disabled
  • enabled
optional
The ValueMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-required
Default value with metric value
defaultValue		text-optional
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
The HistogramMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-required
Default value with metric value
defaultValue		text-optional
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
The SamplingAwareValueMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-required
Default value with metric value
defaultValue		text-optional
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
Sampling
sampling		enum
  • disabled
  • enabled
optional
Aggregation
aggregation		enum
  • disabled
  • enabled
optional
Measurement
measurement		enum
  • field
  • duration
required
The SamplingAwareHistogramMetricAttributes object
PropertyTypeDescriptionRequired
Metric key
metricKey		text-required
Field with metric value
field		text-required
Default value with metric value
defaultValue		text-optional
List of dimensions
dimensions		Set<FieldExtractionEntry>-required
Sampling
sampling		enum
  • disabled
  • enabled
optional
Aggregation
aggregation		enum
  • disabled
  • enabled
optional
Measurement
measurement		enum
  • field
  • duration
required
The DavisAttributes object
PropertyTypeDescriptionRequired
Properties
properties		DavisEventProperty[]-required
The BizeventAttributes object
PropertyTypeDescriptionRequired
Event type
eventType		GenericValueAssignment-optional
Event provider
eventProvider		GenericValueAssignment-required
Field extraction
fieldExtraction		FieldExtraction-required
The SdlcEventAttributes object
PropertyTypeDescriptionRequired
Event type
eventType		GenericValueAssignment-optional
Event provider
eventProvider		GenericValueAssignment-required
Event category
eventCategory		GenericValueAssignment-required
Event status
eventStatus		GenericValueAssignment-required
Field extraction
fieldExtraction		FieldExtraction-required
The SmartscapeNodeAttributes object
PropertyTypeDescriptionRequired
Node type
nodeType		text-required
Node ID field name
nodeIdFieldName		text-required
ID components
idComponents		SmartscapeIdComponentsEntry[]-required
Extract node
extractNode		boolean-required
Node name
nodeName		GenericValueAssignment-required
Fields to extract
fieldsToExtract		SmartscapeFieldExtractionEntry[]-required
Static edges to extract
staticEdgesToExtract		SmartscapeStaticEdgeExtractionEntry[]-required
The SmartscapeEdgeAttributes object
PropertyTypeDescriptionRequired
Source type
sourceType		text-required
Source ID field name
sourceIdFieldName		text-required
Edge type
edgeType		text-required
Target type
targetType		text-required
Target ID field name
targetIdFieldName		text-required
The AzureLogForwardingAttributes object
PropertyTypeDescriptionRequired
ForwarderConfigId
forwarderConfigId		text-required
Field Extraction
fieldExtraction		FieldExtraction-required
The SecurityEventAttributes object
PropertyTypeDescriptionRequired
Field Extraction
fieldExtraction		FieldExtraction-required
The CostAllocationAttributes object
PropertyTypeDescriptionRequired
The strategy to set the cost allocation field
value		GenericValueAssignment-required
The ProductAllocationAttributes object
PropertyTypeDescriptionRequired
The strategy to set product allocation field
value		GenericValueAssignment-required
The FieldsAddAttributesEntry object
PropertyTypeDescriptionRequired
Fields's name
name		text-required
Field's value
value		text-required
The FieldsRenameAttributesEntry object
PropertyTypeDescriptionRequired
Fields's name
fromName		text-required
New field's name
toName		text-required
The GenericValueAssignment object
PropertyTypeDescriptionRequired
Type of value assignment
type		enum
  • constant
  • multiValueConstant
  • field
required
Constant value
constant		text-required
Constant multi value
multiValueConstant		list-required
Value from field
field		ValueAssignmentFromFieldEntry-required
The FieldExtractionEntry object
PropertyTypeDescriptionRequired
Source field name
sourceFieldName		text-required
Destination field name
destinationFieldName		text-optional
Default value
defaultValue		text-optional
The DavisEventProperty object
PropertyTypeDescriptionRequired
Key
key		text-required
Value
value		text-required
The FieldExtraction object
PropertyTypeDescriptionRequired
Fields Extraction type
type		enum
  • include
  • exclude
  • includeAll
required
Fields
include		Set<FieldExtractionEntry>-required
Fields
exclude		set-required
The SmartscapeIdComponentsEntry object
PropertyTypeDescriptionRequired
ID component
idComponent		text-required
Referenced field name
referencedFieldName		text-required
The SmartscapeFieldExtractionEntry object
PropertyTypeDescriptionRequired
Field name
fieldName		text-required
Referenced field name
referencedFieldName		text-required
The SmartscapeStaticEdgeExtractionEntry object
PropertyTypeDescriptionRequired
Edge type
edgeType		text-required
Target type
targetType		text-required
Target ID field name
targetIdFieldName		text-required
The ValueAssignmentFromFieldEntry object
PropertyTypeDescriptionRequired
Source field name
sourceFieldName		text-required
Default value
defaultValue		text-optional