Try it free

Settings API

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Manage Dynatrace settings objects with the Settings API: create, update, list, and delete objects, and check effective values, history, and permissions.

Building a Dynatrace app?

Use the @dynatrace-sdk/client-settings SDK client instead of calling this API directly — it handles authentication, typing, and the environment URL for you. This REST reference is for external and automation use.

Overview

Manage Dynatrace settings through a schema-driven API for storing, querying, and maintaining configuration objects.

Managing settings objects

Create, retrieve, update, delete, reorder, and inspect settings objects. These endpoints also help you resolve effective settings values so you can understand how configuration is applied.

Managing access and ownership

Query and update permissions for settings objects, grant or revoke access for specific users and groups, and change ownership when needed. These endpoints support the security and governance workflows around shared configuration.

Reviewing change history

Retrieve revision history for settings objects to inspect how configuration changed over time. This helps with auditing, troubleshooting, and understanding previous updates.

Working with schemas

Discover and retrieve schema definitions that describe available settings types and their structure. These endpoints help clients understand which properties are supported and how settings objects must be shaped.

Supporting interactive editing

Use helper endpoints for validation, default generation, and value summaries during schema-based editing workflows. These operations are intended to support guided and interactive settings editors.

Authentication

Platform API endpoints use Platform token and OAuth client authentication. Attach a platform token or OAuth access token to the Authorization HTTP header using the Bearer scheme.

--header 'Authorization: Bearer <platform-token-or-oauth-access-token>'

For details, see Tokens and authentication and Platform tokens.

Endpoints

  • Transfer ownership of a settings object (POST /objects/{object-id}:change-owner)
  • List the permissions of a settings object (GET /objects/{object-id}/permissions)
  • Add permissions for an accessor on a settings object (POST /objects/{object-id}/permissions)
  • Get the permissions of an accessor on a settings object (GET /objects/{object-id}/permissions/{accessor-type}/{accessor-id})
  • Update the permissions of an accessor on a settings object (PUT /objects/{object-id}/permissions/{accessor-type}/{accessor-id})
  • Remove the permissions of an accessor on a settings object (DELETE /objects/{object-id}/permissions/{accessor-type}/{accessor-id})
  • Get the all-users permissions of a settings object (GET /objects/{object-id}/permissions/all-users)
  • Update the all-users permissions of a settings object (PUT /objects/{object-id}/permissions/all-users)
  • Remove the all-users permissions of a settings object (DELETE /objects/{object-id}/permissions/all-users)
  • Get a settings object (GET /objects/{object-id})
  • Update a settings object (PUT /objects/{object-id})
  • Delete a settings object (DELETE /objects/{object-id})
  • List settings objects (GET /objects)
  • Create a settings object (POST /objects)
  • Reorder settings objects (POST /objects:reorder)
  • List effective settings values (GET /effective-values)
  • Resolve your effective settings permissions (POST /effective-permissions:resolve)
  • Get the history of settings objects (GET /history)
  • List settings schemas (GET /schemas)
  • Get a settings schema (GET /schemas/{schema-id})
  • Get the default value of a settings schema (GET /values/{schema-id}/default)
  • Generate a summary of a settings value (POST /values/{schema-id}:summarize)
  • Validate a settings property (POST /values/{schema-id}:validate-property)
  • Validate a settings container (POST /values/{schema-id}:validate-container)
Related tags
Platform APIDynatrace Platform