OpenPipeline API - PUT a configuration

Latest Dynatrace
Reference
1-min read
Will deprecate

This API is replaced by dedicated Settings API schemas. To learn how to migrate to the new format, see Migrate OpenPipeline configurations to Settings API.

Updates an OpenPipeline configuration in your Dynatrace environment, replacing any preexisting contents of the configuration with the contents specified in the request body.

Warning

Requests via this endpoint overwrite your entire existing configuration with the new provided content. Empty sections in the new configuration will delete the existing configuration sections. This endpoint does not support a partial update.

The request produces an application/json payload.

PUT SaaS https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/configurations/{id}

You can execute this request also with an OAuth2 client with openpipeline:configurations:write permission.

To learn how to obtain and use it, see OAuth clients.

Parameters

Parameter	Type	Description	In	Required
id	string	Identifier of the configuration.	path	required
body	Configuration	The updated configuration to apply.	body	required

Request body objects

The `Configuration` object

Full configuration containing ingest sources, pipelines, and dynamic routing.

Element	Type	Description	Required
customBasePath	string	The base path for custom ingest endpoints.	required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
endpoints	EndpointDefinition[]	List of all ingest sources of the configuration.	required
id	string	Identifier of the configuration.	required
pipelines	PipelineDefinition[]	List of all pipelines of the configuration.	required
routing	RoutingTable	Dynamic routing definition.	required
updateToken	string	The update token of the configuration. You can use it to detect simultaneous modifications done by different users. It's generated upon retrieval (GET requests). If set on update (PUT request), the update will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update, the operation overrides the current value without any checks.	optional
version	string	The current version of the configuration.	required

The `EndpointDefinition` object

Definition of a single ingest source.

Element	Type	Description	Required
basePath	string	The base path of the ingest source.	required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	optional
defaultBucket	string	The default bucket assigned to records for the ingest source.	optional
displayName	string	Display name of the ingest source.	optional
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
enabled	boolean	Indicates if the object is active.	required
processors	PreProcessingStageProcessor[]	The pre-processing done in the ingest source.	optional
routing	Routing	Routing strategy, either dynamic or static.	required
segment	string	The segment of the ingest source, which is applied to the base path. Must be unique within a configuration.	required
source	string	The ingest source value assigned to records. It is only present for Dynatrace provided objects.	optional

The `PreProcessingStageProcessor` object

Groups all processors applicable for the Pre-ProcessingStage. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, TechnologyProcessor and DropProcessor.

The `Routing` object

Routing strategy, either dynamic or static.

Element	Type	Description	Required
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `static` -> StaticRouting `dynamic` -> DynamicRouting `dynamic` `static`	required

The `PipelineDefinition` object

Definition of a single pipeline, either 'default' or 'classic'.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	optional
costAllocation	CostAllocationStage	Cost Allocation stage configuration of the pipeline.	optional
dataExtraction	DataExtractionStage	Data extraction stage configuration of the pipeline.	optional
displayName	string	Display name of the pipeline.	optional
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
enabled	boolean	Indicates if the object is active.	required
id	string	Identifier of the pipeline.	required
metricExtraction	MetricExtractionStage	Metric extraction stage configuration of the pipeline.	optional
productAllocation	ProductAllocationStage	Product Allocation stage configuration of the pipeline.	optional
securityContext	SecurityContextStage	Security context stage configuration of the pipeline.	optional
storage	StorageStage	Storage stage configuration of the pipeline.	optional
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `default` -> DefaultPipelineDefinition `classic` -> ClassicPipelineDefinition `classic` `default`	required

The `CostAllocationStage` object

Cost Allocation stage configuration of the pipeline.

Element	Type	Description	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
processors	CostAllocationStageProcessor[]	List of processors.	required

The `CostAllocationStageProcessor` object

Groups all processors applicable for the CostAllocationStageProcessor. Applicable processor is CostAllocationProcessor.

The `DataExtractionStage` object

Data extraction stage configuration of the pipeline.

Element	Type	Description	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
processors	DataExtractionStageProcessor[]	List of processors.	required

The `DataExtractionStageProcessor` object

Groups all processors applicable for the DataExtractionStage. Applicable processors are DavisEventExtractionProcessor, BizeventExtractionProcessor, and SecurityEventExtractionProcessor.

The `MetricExtractionStage` object

Metric extraction stage configuration of the pipeline.

Element	Type	Description	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
processors	MetricExtractionStageProcessor[]	List of processors.	required

The `MetricExtractionStageProcessor` object

Groups all processors applicable for the MetricExtractionStage. Applicable processors are CounterMetricExtractionProcessor and ValueMetricExtractionProcessor SamplingAwareCounterMetricExtractionProcessor, and SamplingAwareValueMetricExtractionProcessor.

The `ProductAllocationStage` object

Product Allocation stage configuration of the pipeline.

Element	Type	Description	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
processors	ProductAllocationStageProcessor[]	List of processors.	required

The `ProductAllocationStageProcessor` object

Groups all processors applicable for the ProductAllocationStage. Applicable processor is ProductAllocationProcessor.

The `SecurityContextStage` object

Security context stage configuration of the pipeline.

Element	Type	Description	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
processors	SecurityContextStageProcessor[]	List of processors.	required

The `SecurityContextStageProcessor` object

Groups all processors applicable for the SecurityContextStage. Applicable processor is SecurityContextProcessor.

The `StorageStage` object

Storage stage configuration of the pipeline.

Element	Type	Description	Required
catchAllBucketName	string	Default bucket assigned to records which don't match any other storage processor.	optional
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
processors	StorageStageProcessor[]	List of processors.	required

The `StorageStageProcessor` object

Groups all processors applicable for the StorageStage. Applicable processors are BucketAssignmentProcessor and NoStorageProcessor.

The `RoutingTable` object

Dynamic routing definition.

Element	Type	Description	Required
catchAllPipeline	RoutingTableEntryTarget	The default pipeline records are routed into if no dynamic routing entries apply.	required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
entries	RoutingTableEntry[]	List of all dynamic routes.	required

The `RoutingTableEntryTarget` object

The default pipeline records are routed into if no dynamic routing entries apply.

Element	Type	Description	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
pipelineId	string	Identifier of the pipeline.	required

The `RoutingTableEntry` object

Dynamic routing entry.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	optional
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	optional
enabled	boolean	Indicates if the object is active.	required
matcher	string	Matching condition to apply to incoming records.	required
note	string	Unique note describing the dynamic route.	required
pipelineId	string	Identifier of the pipeline the record is routed into.	required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "id": "events",
  "editable": false,
  "version": "1719220519649-ff2897a62cf849b0baa95e71fa4d5f1f",
  "updateToken": "NzgyMTVjYzAtOWYwNC0zZjQ1LWFmNzgtMWQ3OWZjNzdkYjMwX2E3YzZkN2QwLTdmMzctMTFlZi04MDAxLTAxMDAwMDAwMDAwMQ==",
  "customBasePath": "/platform/ingest/custom/events",
  "endpoints": [
    {
      "enabled": true,
      "builtin": false,
      "editable": false,
      "basePath": "/platform/ingest/custom/events",
      "segment": "home",
      "displayName": "Endpoint for home automation",
      "defaultBucket": "home_automation_events",
      "processors": [
        {
          "type": "fieldsRename",
          "enabled": false,
          "editable": true,
          "id": "hostname-field-normalizer",
          "description": "hostname field normalizer",
          "matcher": "isNotNull(\"hostname\")",
          "sampleData": "{\"hostname\": \"raspberry-pi 4\",\"ip\":\"10.0.0.123\"}",
          "fields": [
            {
              "fromName": "hostname",
              "toName": "host.name"
            },
            {
              "fromName": "ip",
              "toName": "ip.address"
            }
          ]
        },
        {
          "type": "fieldsAdd",
          "enabled": false,
          "editable": true,
          "id": "add-source-field",
          "description": "Add source field",
          "matcher": "true",
          "sampleData": "{\"hostname\": \"raspberry-pi 4\",\"ip\":\"10.0.0.123\"}",
          "fields": [
            {
              "name": "source",
              "value": "home-automation"
            }
          ]
        }
      ],
      "routing": {
        "type": "dynamic"
      }
    },
    {
      "enabled": true,
      "builtin": true,
      "editable": false,
      "basePath": "/platform/ingest/v1/events",
      "segment": "",
      "source": "/platform/ingest/v1/events",
      "displayName": "Default API",
      "processors": [],
      "routing": {
        "type": "dynamic"
      }
    }
  ],
  "pipelines": [
    {
      "type": "default",
      "enabled": true,
      "editable": false,
      "id": "home-automation",
      "builtin": false,
      "displayName": "Home automation pipeline",
      "storage": {
        "editable": false,
        "catchAllBucketName": "home_automation_events",
        "processors": [
          {
            "type": "noStorage",
            "id": "don-not-store-debug-events",
            "description": "Do not store debugging events",
            "enabled": true,
            "editable": false,
            "matcher": "severity==\"debug\"",
            "sampleData": "{}"
          },
          {
            "type": "bucketAssignment",
            "enabled": true,
            "editable": false,
            "id": "bucket-assignment-security-relevent-events",
            "description": "Store security-relevant events in a dedicated bucket",
            "matcher": "type==\"security\"",
            "sampleData": "{}",
            "bucketName": "home_automation_security_events"
          }
        ]
      },
      "securityContext": {
        "editable": false,
        "processors": [
          {
            "type": "securityContext",
            "id": "security-context",
            "description": "Mark security context for supervisors",
            "enabled": true,
            "editable": false,
            "matcher": "type==\"security\"",
            "sampleData": "{}",
            "value": {
              "type": "constant",
              "constant": "supervisors"
            }
          }
        ]
      },
      "metricExtraction": {
        "editable": false,
        "processors": [
          {
            "type": "counterMetric",
            "id": "click-counter-metric",
            "description": "Counts the clicks on a button",
            "enabled": true,
            "editable": true,
            "matcher": "device.type==\"button\"",
            "sampleData": "{}",
            "metricKey": "events.home.button.click",
            "dimensions": [
              "device.name",
              "device.location"
            ]
          },
          {
            "type": "valueMetric",
            "id": "temperature-value-metric",
            "description": "description",
            "enabled": true,
            "editable": true,
            "matcher": "device.type==\"temperature-sensor\"",
            "sampleData": "{}",
            "metricKey": "events.home.temperature",
            "dimensions": [
              "device.name",
              "device.location"
            ],
            "field": "temperature"
          }
        ]
      },
      "dataExtraction": {
        "editable": false,
        "processors": []
      },
      "processing": {
        "editable": false,
        "processors": []
      }
    },
    {
      "type": "default",
      "enabled": true,
      "editable": false,
      "id": "default",
      "builtin": true,
      "displayName": "events",
      "storage": {
        "editable": false,
        "catchAllBucketName": "default_events",
        "processors": []
      },
      "securityContext": {
        "editable": false,
        "processors": []
      },
      "metricExtraction": {
        "editable": false,
        "processors": []
      },
      "dataExtraction": {
        "editable": false,
        "processors": []
      },
      "processing": {
        "editable": false,
        "processors": []
      }
    }
  ],
  "routing": {
    "editable": false,
    "catchAllPipeline": {
      "editable": false,
      "pipelineId": "default"
    },
    "entries": [
      {
        "enabled": true,
        "editable": false,
        "builtin": false,
        "pipelineId": "home-automation",
        "matcher": "source==\"home-automation\"",
        "note": "Route all home automation events into a dedicated pipeline."
      }
    ]
  }
}

Response

Response codes

Code	Type	Description
202	-	Configuration change was accepted.
404	ErrorResponseEnvelope	Migration in-progress/completed, the requested resource is no longer available.
409	ErrorResponseEnvelope	Version conflict. Check the description of 'updateToken' parameter of request body for more details.
413	ErrorResponseEnvelope	Max payload size of 10 MiB exceeded.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

JSON models

The `ConstantValueAssignment` object

Assign a constant value.

Element	Type	Description
constant	string	The constant value to assign.

The `FieldValueAssignment` object

Assign a value extracted from a field.

Element	Type	Description
field	string	The field on the record to extract the value for assignment.

The `ConstantMultiValueAssignment` object

Assign a multi-value constant.

Element	Type	Description
multiValueConstant	string[]	The constant multi value to assign.

The `StaticRouting` object

Records are statically routed to the defined pipeline.

Element	Type	Description
pipelineId	string	Identifier of the pipeline.

The `DynamicRouting` object

Records are routed via the dynamic routes.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `static` -> StaticRouting `dynamic` -> DynamicRouting `dynamic` `static`

The `ClassicPipelineDefinition` object

Definition of a classic pipeline which are configured via settings 2.0. This only applies to the logs and bizevents configuration.

Element	Type	Description
processing	ClassicProcessingStage	Processing stage configuration of the pipeline.
settingsSchema	string	The settings-schema identifier related to the processing of the classic pipeline.

The `ClassicProcessingStage` object

Processing stage configuration of the pipeline.

Element	Type	Description
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
processors	ClassicProcessingStageProcessor[]	List of processors.

The `ClassicProcessingStageProcessor` object

Groups all processors applicable for the ClassicProcessingStage. Applicable processor is SxqlProcessor.

The `DefaultPipelineDefinition` object

Definition of a single default pipeline.

Element	Type	Description
processing	ProcessingStage	Processing stage configuration of the pipeline.

The `ProcessingStage` object

Processing stage configuration of the pipeline.

Element	Type	Description
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
processors	ProcessingStageProcessor[]	List of processors.

The `ProcessingStageProcessor` object

Groups all processors applicable for the ProcessingStage. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, TechnologyProcessor and DropProcessor.

The `BizeventExtractionProcessor` object

Processor to extract a bizevent. Fields event.type and event.provider can only be assigned to a constant or field value. A multi-value constant is not supported for those fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
eventProvider	ValueAssignment	Strategy to assign a value.
eventType	ValueAssignment	Strategy to assign a value.
fieldExtraction	FieldsExtraction	Definition of the field extraction.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `FieldsExtraction` object

Definition of the field extraction.

Element	Type	Description
fields	string[]	Unique fields to include/exclude in the extracted record.
semantic	string	Defines how the fields of the source record should be extracted. INCLUDE: Only the specified fields are extracted. INCLUDE_ALL: All fields are extracted. EXCLUDE: All fields except the specified fields are extracted. `EXCLUDE` `INCLUDE` `INCLUDE_ALL`

The `DavisEventExtractionProcessor` object

Processor to extract a davis event.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
properties	DavisEventProperty[]	List of properties for the extracted davis event.
sampleData	string	Sample data related to the processor for documentation or testing.

The `DavisEventProperty` object

List of properties for the extracted davis event.

Element	Type	Description
key	string	The key to set on the davis event.
value	string	The value assigned to the key.

The `SecurityEventExtractionProcessor` object

Processor to extract a security event.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fieldExtraction	FieldsExtraction	Definition of the field extraction.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsExtraction` object

Definition of the field extraction.

Element	Type	Description
fields	string[]	Unique fields to include/exclude in the extracted record.
semantic	string	Defines how the fields of the source record should be extracted. INCLUDE: Only the specified fields are extracted. INCLUDE_ALL: All fields are extracted. EXCLUDE: All fields except the specified fields are extracted. `EXCLUDE` `INCLUDE` `INCLUDE_ALL`

The `DqlProcessor` object

Processor to apply a DQL script.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
dqlScript	string	The DQL script to apply on the record.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsAddProcessor` object

Processor to add fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fields	FieldsAddItem[]	List of fields to add to the record.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsAddItem` object

List of fields to add to the record.

Element	Type	Description
name	string	Name of the field.
value	string	Value to assign to the field.

The `FieldsRemoveProcessor` object

Processor to remove fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fields	string[]	List of unique fields to remove from the record.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsRenameProcessor` object

Processor to rename fields.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
fields	FieldsRenameItem[]	List of fields to rename on the record.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `FieldsRenameItem` object

List of fields to rename on the record.

Element	Type	Description
fromName	string	The field to rename.
toName	string	The new field name.

The `TechnologyProcessor` object

Processor to apply a technology processors.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
customMatcher	string	Optional customer-defined matching condition, that is used in place of the main technology matcher.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
sampleData	string	Sample data related to the processor for documentation or testing.
technologyId	string	The reference identifier to a specific technology. This technology is applied on the record.

The `DropProcessor` object

Processor to drop the record either during the processing stage or at the endpoint.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `NoStorageProcessor` object

Processor to skip storage assignment.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `BucketAssignmentProcessor` object

Processor to assign a bucket.

Element	Type	Description
bucketName	string	Bucket that is assigned when the record is matched.
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.

The `SecurityContextProcessor` object

Processor to set the security context field.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.
value	ValueAssignment	Strategy to assign a value.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `CounterMetricExtractionProcessor` object

Processor to write the occurrences as a metric.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
dimensions	string[]	List of unique dimensions to add to the metric. Dimensions are represented in the format `({dimensionName}=)?{sourceField}`. `{dimensionName}` is optional if `{sourceField}` represents a valid metric dimension name. `{sourceField}` has to represent a valid DQL field accessor and it can access a nested field (for example, `field[field2][0]`).
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
metricKey	string	The key of the metric to write.
sampleData	string	Sample data related to the processor for documentation or testing.

The `ValueMetricExtractionProcessor` object

Processor to extract a value from a field as a metric.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
defaultValue	string	The default value to use if the given field value could not be extracted. String value must be a number.
description	string	Name or description of the processor.
dimensions	string[]	List of unique dimensions to add to the metric. Dimensions are represented in the format `({dimensionName}=)?{sourceField}`. `{dimensionName}` is optional if `{sourceField}` represents a valid metric dimension name. `{sourceField}` has to represent a valid DQL field accessor and it can access a nested field (for example, `field[field2][0]`).
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
field	string	The field to extract the value for the metric.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
metricKey	string	The key of the metric to write.
sampleData	string	Sample data related to the processor for documentation or testing.

The `CostAllocationProcessor` object

Processor to set the cost allocation field.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.
value	ValueAssignment	Strategy to assign a value.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `ProductAllocationProcessor` object

Processor to set the product allocation field.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
description	string	Name or description of the processor.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
sampleData	string	Sample data related to the processor for documentation or testing.
value	ValueAssignment	Strategy to assign a value.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `ErrorResponseEnvelope` object

Encloses the encountered error.

Element	Type	Description
error	ErrorResponse	Basic information of the encountered error.

The `ErrorResponse` object

Basic information of the encountered error.

Element	Type	Description
code	integer	The returned HTTP status code.
details	ErrorResponseDetails	Detailed information of the error.
message	string	Description of the encountered error.

The `ErrorResponseDetails` object

Detailed information of the error.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constraintViolation` -> ConstraintViolationDetails `constraintViolation`

The `ConstraintViolationDetails` object

List of encountered constraint violations.

Element	Type	Description
constraintViolations	ConstraintViolation[]	List of encountered constraint violations.

The `ConstraintViolation` object

Information about a single constraint violation.

Element	Type	Description
context	object	Structured context of the constraint violation. Well known keys that can be present are: `reason` -> Additional reasoning behind the occurred violation. `pipeline` -> Pipeline related to the violation. `endpoint` -> Endpoint related to the violation. `stage` -> Stage related to the violation. `processor` -> Processor related to the violation. `routingRule` -> Routing rule related to the violation.
message	string	Description of the constraint violation.

OpenPipeline API - PUT a configuration

Parameters

Request body objects

The Configuration object

The EndpointDefinition object

The PreProcessingStageProcessor object

The Routing object

The PipelineDefinition object

The CostAllocationStage object

The CostAllocationStageProcessor object

The DataExtractionStage object

The DataExtractionStageProcessor object

The MetricExtractionStage object

The MetricExtractionStageProcessor object

The ProductAllocationStage object

The ProductAllocationStageProcessor object

The SecurityContextStage object

The SecurityContextStageProcessor object

The StorageStage object

The StorageStageProcessor object

The RoutingTable object

The RoutingTableEntryTarget object

The RoutingTableEntry object

Request body JSON model

Response

Response codes

JSON models

The ConstantValueAssignment object

The FieldValueAssignment object

The ConstantMultiValueAssignment object

The StaticRouting object

The DynamicRouting object

The ClassicPipelineDefinition object

The ClassicProcessingStage object

The ClassicProcessingStageProcessor object

The DefaultPipelineDefinition object

The ProcessingStage object

The ProcessingStageProcessor object

The BizeventExtractionProcessor object

The ValueAssignment object

The FieldsExtraction object

The DavisEventExtractionProcessor object

The DavisEventProperty object

The SecurityEventExtractionProcessor object

The FieldsExtraction object

The DqlProcessor object

The FieldsAddProcessor object

The FieldsAddItem object

The FieldsRemoveProcessor object

The FieldsRenameProcessor object

The FieldsRenameItem object

The TechnologyProcessor object

The DropProcessor object

The NoStorageProcessor object

The BucketAssignmentProcessor object

The SecurityContextProcessor object

The ValueAssignment object

The CounterMetricExtractionProcessor object

The ValueMetricExtractionProcessor object

The CostAllocationProcessor object

The ValueAssignment object

The ProductAllocationProcessor object

The ValueAssignment object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

The ConstraintViolationDetails object

The ConstraintViolation object

The `Configuration` object

The `EndpointDefinition` object

The `PreProcessingStageProcessor` object

The `Routing` object

The `PipelineDefinition` object

The `CostAllocationStage` object

The `CostAllocationStageProcessor` object

The `DataExtractionStage` object

The `DataExtractionStageProcessor` object

The `MetricExtractionStage` object

The `MetricExtractionStageProcessor` object

The `ProductAllocationStage` object

The `ProductAllocationStageProcessor` object

The `SecurityContextStage` object

The `SecurityContextStageProcessor` object

The `StorageStage` object

The `StorageStageProcessor` object

The `RoutingTable` object

The `RoutingTableEntryTarget` object

The `RoutingTableEntry` object

The `ConstantValueAssignment` object

The `FieldValueAssignment` object

The `ConstantMultiValueAssignment` object

The `StaticRouting` object

The `DynamicRouting` object

The `ClassicPipelineDefinition` object

The `ClassicProcessingStage` object

The `ClassicProcessingStageProcessor` object

The `DefaultPipelineDefinition` object

The `ProcessingStage` object

The `ProcessingStageProcessor` object

The `BizeventExtractionProcessor` object

The `ValueAssignment` object

The `FieldsExtraction` object

The `DavisEventExtractionProcessor` object

The `DavisEventProperty` object

The `SecurityEventExtractionProcessor` object

The `FieldsExtraction` object

The `DqlProcessor` object

The `FieldsAddProcessor` object

The `FieldsAddItem` object

The `FieldsRemoveProcessor` object

The `FieldsRenameProcessor` object

The `FieldsRenameItem` object

The `TechnologyProcessor` object

The `DropProcessor` object

The `NoStorageProcessor` object

The `BucketAssignmentProcessor` object

The `SecurityContextProcessor` object

The `ValueAssignment` object

The `CounterMetricExtractionProcessor` object

The `ValueMetricExtractionProcessor` object

The `CostAllocationProcessor` object

The `ValueAssignment` object

The `ProductAllocationProcessor` object

The `ValueAssignment` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `ConstraintViolationDetails` object

The `ConstraintViolation` object