List available OpenPipeline configuration identifiers in Dynatrace, and filter the results by configuration ID when you need a specific configuration.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/configurations |
You can filter the results by configurationId to return only the selected configuration. Dynatrace returns the list of available configuration identifiers.
To execute this request, you need a platform token or OAuth access token with openpipeline:configurations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| configurationId | string | Returns results only for the selected configuration. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Configuration | List of available configurations. |
| 4XX | Error | Client-side error. |
| 5XX | Error | Server-side error. |
ResponseBody objectConfigurationListItem objectBasic information about a configuration.
| Element | Type | Description |
|---|---|---|
| definition | Configuration | 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. |
ConfigurationSpecification objectProvides additional information about the configuration.
| Element | Type | Description |
|---|---|---|
| bucketsSpecification | Buckets | Contains information about allowed buckets for the configuration. |
| catchAllPipeline | string | The default pipeline records are routed into if no dynamic routing entries apply. |
| endpointsSpecification | Endpoints | Contains information about allowed endpoints for the configuration scope. |
| forwardingSpecification | Forwarding | Contains information about allowed processors, grouped by stages, for the forwarding. |
| metricKeyPrefix | string | The key prefix that will be set when a metric for this configuration is extracted. |
| pipelinesSpecification | Pipelines | Contains information about allowed processors, grouped by stages, for the configuration. |
BucketsSpecification objectContains 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. |
EndpointsSpecification objectContains 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. |
ForwardingSpecification objectContains information about allowed processors, grouped by stages, for the forwarding.
| Element | Type | Description |
|---|---|---|
| availableHypervisors | string[] | Contains information about the available hypervisors to which data can be forwarded. |
| processingStages | object | Contains information about allowed processors per stage for the forwarding. |
PipelinesSpecification objectContains 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. |
| security | string[] | Contains information about allowed processors, for the 'Security' stage of the pipeline, for configuration. |
| securityContext | string[] | Contains information about allowed processors, for the 'Permission' stage of the pipeline, for configuration. |
| smartscapeEdgeExtraction | string[] | Contains information about allowed processors, for the 'Smartscape Edge Extraction' stage of the pipeline, for the configuration. |
| smartscapeNodeExtraction | string[] | Contains information about allowed processors, for the 'Smartscape Node Extraction' stage of the pipeline, for the configuration. |
| storage | string[] | Contains information about allowed processors, for the 'Storage' stage of the pipeline, for the configuration. |
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed 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:
The element can hold these values
|
[{"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"}}}]
{"error": {"code": 400,"message": "Bad request."}}