OpenPipeline API - GET all configurations

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.

Lists all OpenPipeline configuration IDs available in your Dynatrace environment.

The request produces an application/json payload.

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

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

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

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

Code	Type	Description
200	ConfigurationListItem[]	List of available configurations.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `ResponseBody` object

The `ConfigurationListItem` object

Basic information about a configuration.

Element	Type	Description
definition	ConfigurationSpecification	Provides additional information about the configuration.
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
id	string	Identifier of the configuration.

The `ConfigurationSpecification` object

Provides additional information about the configuration.

Element	Type	Description
bucketsSpecification	BucketsSpecification	Contains information about allowed buckets for the configuration.
catchAllPipeline	string	The default pipeline records are routed into if no dynamic routing entries apply.
endpointsSpecification	EndpointsSpecification	Contains information about allowed endpoints for the configuration scope.
metricKeyPrefix	string	The key prefix that will be set when a metric for this configuration is extracted.
pipelinesSpecification	PipelinesSpecification	Contains information about allowed processors, grouped by stages, for the configuration.

The `BucketsSpecification` object

Contains information about allowed buckets for the configuration.

Element	Type	Description
bucketTable	string	The bucket table containing the allowed buckets for the configuration.
defaultBucket	string	The default bucket that will be used to store records if nothing else is defined in the processing rules.

The `EndpointsSpecification` object

Contains information about allowed endpoints for the configuration scope.

Element	Type	Description
customBasePath	string	The base path for custom ingest endpoints.
customEndpoints	boolean	Indicates whether custom endpoints can be created for the configuration.

The `PipelinesSpecification` object

Contains information about allowed processors, grouped by stages, for the configuration.

Element	Type	Description
costAllocation	string[]	Contains information about allowed processors, for the 'Cost Allocation' stage of the pipeline, for configuration.
dataExtraction	string[]	Contains information about allowed processors, for the 'Data Extraction' stage of the pipeline, for the configuration.
davis	string[]	Contains information about allowed processors, for the 'Davis' stage of the pipeline, for the configuration.
metricExtraction	string[]	Contains information about allowed processors, for the 'Metric Extraction' stage of the pipeline, for the configuration.
processing	string[]	Contains information about allowed processors, for the 'Processing' stage of the pipeline, for the configuration.
productAllocation	string[]	Contains information about allowed processors, for the 'Product Allocation' stage of the pipeline, for configuration.
securityContext	string[]	Contains information about allowed processors, for the 'Permission' stage of the pipeline, for configuration.
storage	string[]	Contains information about allowed processors, for the 'Storage' stage of the pipeline, for the configuration.

Response body JSON model

[
  {
    "id": "logs",
    "editable": false,
    "definition": {
      "endpointsSpecification": {
        "customEndpoints": false
      },
      "pipelinesSpecification": {
        "processing": [
          "drop",
          "fieldsRemove",
          "fieldsRename",
          "technology",
          "dql",
          "fieldsAdd"
        ],
        "dataExtraction": [
          "bizevent",
          "davis"
        ],
        "metricExtraction": [
          "valueMetric",
          "counterMetric"
        ],
        "securityContext": [
          "securityContext"
        ],
        "storage": [
          "noStorage",
          "bucketAssignment"
        ]
      },
      "metricKeyPrefix": "log",
      "bucketsSpecification": {
        "defaultBucket": "default_logs",
        "bucketTable": "logs"
      }
    }
  },
  {
    "id": "events",
    "editable": false,
    "definition": {
      "endpointsSpecification": {
        "customEndpoints": true
      },
      "pipelinesSpecification": {
        "processing": [
          "drop",
          "fieldsRemove",
          "fieldsRename",
          "dql",
          "fieldsAdd"
        ],
        "dataExtraction": [
          "davis"
        ],
        "metricExtraction": [
          "valueMetric",
          "counterMetric"
        ],
        "securityContext": [
          "securityContext"
        ],
        "storage": [
          "noStorage",
          "bucketAssignment"
        ]
      },
      "metricKeyPrefix": "events",
      "bucketsSpecification": {
        "defaultBucket": "default_events",
        "bucketTable": "events"
      }
    }
  },
  {
    "id": "bizevents",
    "editable": false,
    "definition": {
      "endpointsSpecification": {
        "customEndpoints": false
      },
      "pipelinesSpecification": {
        "processing": [
          "drop",
          "fieldsRemove",
          "fieldsRename",
          "dql",
          "fieldsAdd"
        ],
        "dataExtraction": [
          "davis"
        ],
        "metricExtraction": [
          "valueMetric",
          "counterMetric"
        ],
        "securityContext": [
          "securityContext"
        ],
        "storage": [
          "noStorage",
          "bucketAssignment"
        ]
      },
      "metricKeyPrefix": "bizevents",
      "bucketsSpecification": {
        "defaultBucket": "default_bizevents",
        "bucketTable": "bizevents"
      }
    }
  }
]

JSON models

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 - GET all configurations

Parameters

Response

Response codes

Response body objects

The ResponseBody object

The ConfigurationListItem object

The ConfigurationSpecification object

The BucketsSpecification object

The EndpointsSpecification object

The PipelinesSpecification object