OpenPipeline API - GET all configurations

Lists all OpenPipeline configuration IDs available in your Dynatrace environment.

The request produces an application/json payload.

GETSaaShttps://{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

List of available configurations.

4XX

Client-side error.

5XX

Server-side error.

Response body objects

The ResponseBody object

The ConfigurationListItem object

Basic information about a configuration.

Element
Type
Description
definition

Provides additional information about the configuration.

editable
boolean

Indicates if the user is allowed to 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

Contains information about allowed buckets for the configuration.

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

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
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
dataExtraction
string[]

It contains information about allowed processors, for the 'Data Extraction' stage of the pipeline, for the configuration.

metricExtraction
string[]

It contains information about allowed processors, for the 'Metric Extraction' stage of the pipeline, for the configuration.

processing
string[]

It contains information about allowed processors, for the 'Processing' stage of the pipeline, for the configuration.

securityContext
string[]

It contains information about allowed processors, for the 'Permission' stage of the pipeline, for configuration.

storage
string[]

It 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

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

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

The ConstraintViolationDetails object

List of encountered constraint violations.

Element
Type
Description
constraintViolations

List of encountered constraint violations.

The ConstraintViolation object

Information about a single constraint violation.

Element
Type
Description
message
string

Description of the constraint violation.