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

Authentication

To execute this request, you need an access token with settings.read scope.

To learn how to obtain and use it, see Tokens and authentication.

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
editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

id
string

Identifier of the configuration.

Response body JSON model

[
{
"id": "logs",
"editable": false
},
{
"id": "events",
"editable": false
},
{
"id": "bizevents",
"editable": false
}
]

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.