Migrate OpenPipeline Configurations API to Settings API

  • Latest Dynatrace
  • How-to guide
  • 3-min read
  • Published Sep 09, 2025

Migrating your OpenPipeline configuration from OpenPipeline Configurations API to Settings API facilitates configuration management on a larger scale. This is achieved through a fine-grained approach to permissions. It introduces a hierarchical split of configurations for enterprises with many teams, giving teams flexibility in ingesting and processing data according to their needs while maintaining adaptable control by monitoring and SRE teams.

Why migrate

With configuration via Settings API, you get:

  • Dedicated permissions and owner-based access control for pipelines and ingest sources. Users can create, delete, and share access to their own pipelines and ingest sources without an intermediate administrator step.
  • Each data type has separate objects for: routing, individual pipelines, and individual ingest sources. Instead of a single large JSON file, Dynatrace Configuration as Code users can now distribute multiple files in their repositories.

What's in scope of the migration?

The OpenPipeline Configurations API is replaced by the Settings API and the schemas for each data type

  • Routing (builtin:openpipeline.<data.type>:routing)
  • Pipelines (builtin:openpipeline.<data.type>:pipelines)
  • Ingest sources (builtin:openpipeline.<data.type>:ingest-sources)

The migration affects endpoint URLs, query parameters, and response/request body parameters, as well as the scope of the token for the request.

Base URL

new Settings 2.0old OpenPipeline Configurations API
/api/v2/settings/api/platform/openpipeline/v1/configurations

Authentication token scope

new Settings 2.0old OpenPipeline Configurations API
Read settings (settings.read)
Write settings (settings.write)		Read configuration (openpipeline:configurations:read)
Write configuration (openpipeline:configurations:write)

Parameters

To learn about new query/body parameters, see the documentation of individual requests in the Settings 2.0 - Available schemas.

In the Settings 2.0 framework, OpenPipeline routing for each data type, individual pipelines, and individual ingest sources are represented by a settings object. An object contains some metadata (like the scope or creation timestamp) and its configuration, encapsulated in the value object. To learn about the parameters of routing, pipelines, and ingest sources, query the related schema with a GET request.

The new Settings API schemas for routing, pipelines, and ingest sources have dedicated permissions as described in the table below.

new Settings 2.0old OpenPipeline Configurations API
settings:objects:readopenpipeline:configurations:read
settings:objects:writeopenpipeline:configurations:write

Additionally, the pipeline and ingest source schemas have object owners and accessors.

Owner

The first user to store the object. Owners have read and write access to the objects they create and can delete it or share it with other users.

Accessor

One or multiple users who can access an object shared by an owner.

Therefore a pipeline or ingest source can be accessed by a user that is one of the following:

  • The owner of the object.
  • An accessor of the object with sufficient permissions (settings:objects:read or settings:objects:write).

Administrators with settings:objects:admin permissions have unlimited read and write access to all objects. Administrators can also share access to objects that have an owner and change the owner.

What's not in scope of the migration

The migration won't affect

  • Other OpenPipeline API endpoints and their permissions
    • The OpenPipeline Preview API, Matcher API, DQL Processor API, and Technology API remain unchanged.
    • The permissions openpipeline:configurations: read and openpipeline:configurations:write remain valid for the above endpoints.
  • OpenPipeline Ingest API

Before you migrate

  • This migration is a permanent change and cannot be undone.
  • During the migration, your configuration is locked. Dynatrace automatically translates the existing configuration to the new API format. Once the migration is successfull, the OpenPipeline Configurations API can no longer be used.
  • Warning Breaking change
    • You must update policies and integrations based on the OpenPipeline Configurations API.
    • If you are using Dynatrace Configuration as Code, you must download the new configuration before or immediately after the migration.

We recommend that you back up your existing configuration before starting the migration.

Prerequisites

The following permissions are required:

  • openpipeline:configurations:write
  • settings:objects:admin
  • app-settings:objects:admin

How to migrate?

To ensure a seamless transition, adapt your existing policies based on the OpenPipeline Configurations API before migrating to the new Settings API schemas.

  1. Go to Account Management > Identity and Access Management

  2. Update the existing policies.

    To allow users to read and write OpenPipeline configurations with the Settings API schemas make sure the following permissions are in use

    • For standard users, settings:objects:read (read access) and settings:objects:write (write access)

    • For administrators, settings:objects:admin (read and write access)

Review the integrations that use the OpenPipeline Configurations API endpoints, such as API calls, scripts, configurations-as-code files, or third-party integrations. Make sure to use the new Settings API schemas instead.

To migrate your OpenPipeline configuration to the new API

  1. Go to Settings Settings > Process and contextualize > OpenPipeline and select any data type.

    This process will migrate all data types, regardless of which one you select.

  2. In the upper part of the data type page, select Migrate in the dedicated banner.

    The migration process will start automatically. It will take a few minutes to complete.

    When them migration completes successfully, a Migration successful message appears. Configurations for all data types have been migrated to the new API.

    The following endpoints can no longer be used:

    • GET /platform/openpipeline/v1/configurations

    • GET /platform/openpipeline/v1/configurations/{id}

    • PUT /platform/openpipeline/v1/configurations/{id}

If you are not using configuration as code, you can skip this step.

Dynatrace has migrated the OpenPipeline Configurations API to the Settings API schema automatically for you, therefore you don't need to manually look into the configuration files.

To complete the migration,

  1. Download and create new configuration-as-code files containing the new configuration.

  2. Modify all necessary configuration files containing the old schema ID with the new schema ID.

  3. Delete the old configurations files.

What to do after the migration?

  • Set up Owner-based access control to start handing-over the configuration reponsibility for pipelines to the individual teams who own the data.

  • Preview You can enroll in the Preview program with higher configuration limits, up to 2,000 pipelines. To enroll in the program, contact a Dynatrace product expert via live chat.