Try it free

Get a settings object

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Retrieve a settings object in Dynatrace with the App Settings API, including secret fields that are masked unless called from your app's serverless function.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/v2/objects/{object-id}

Overview

You provide the object ID path parameter, and you can optionally set admin-access when you have app-settings:objects:admin permission. The response returns the specified settings object, with secret properties shown in plain text only for serverless app calls and masked otherwise.

Authentication

To execute this request, you need a platform token or OAuth access token with app-settings:objects:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
object-idstring

The ID of the required settings object

pathRequired
admin-accessboolean

If set to true and user has app-settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects

queryOptional

Response

Response codes

CodeTypeDescription
200AppSettingsObject

Success

400ErrorResponse

Failed. The input is invalid.

403ErrorResponse

Failed. Forbidden.

404ErrorResponse

No object available for the given objectId

429--
503--
4XX--
5XX--

Response body objects

The AppSettingsObject object

A settings object.

ElementTypeDescription
objectIdstring

The ID of the settings object.

summarystring

A short summary of settings. This can contain Markdown and will be escaped accordingly.

searchSummarystring

A searchable summary string of the setting value. Plain text without Markdown.

versionstring

The version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users.

It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.

schemaIdstring

The schema on which the object is based.

schemaVersionstring

The version of the schema on which the object is based.

modificationInfoModificationInfo

Modification information about the setting.

resourceContextResourceContext

The resource context, which contains additional permission information about the object.

valueAppSettingsValueRaw

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

ownerIdentity-

The ModificationInfo object

Modification information about the setting.

ElementTypeDescription
createdBystring

The unique identifier of the user who created the setting.

createdTimestring

Timestamp when the setting was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

lastModifiedBystring

The unique identifier of the user who performed the most recent modification.

lastModifiedTimestring

Timestamp when the setting was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

lastModifiedReasonstring

The reason for the most recent modification, if available.

The ResourceContext object

The resource context, which contains additional permission information about the object.

ElementTypeDescription
operationsstring[]

The allowed operations on this settings object.

The element can hold these values
  • read
  • write
  • delete
modificationsModifications

The additional modification details for this settings object.

The Modifications object

The additional modification details for this settings object.

ElementTypeDescription
firstboolean

If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list).

modifiablePathsstring[]

Property paths which are modifiable, regardless if the write operation is allowed.

movableboolean

If settings object can be moved/reordered. Only applicable for ordered list schema.

nonModifiablePathsstring[]

Property paths which are not modifiable, even if the write operation is allowed.

The AppSettingsValueRaw object

The value of the setting.

It defines the actual values of settings' parameters.

The actual content depends on the object's schema.

The Identity object

ElementTypeDescription
typestring-
The element can hold these values
  • user
  • group
  • all-users
idstring

user id or user group id if type is 'user' or 'group', missing if type is 'all-users'

The ErrorResponse object

ElementTypeDescription
errorError

Standard error response

The Error object

Standard error response

ElementTypeDescription
codenumber

The error code (HTTP response)

messagestring

The error message

retryAfterSecondsnumber

Number of seconds a request can be retried after a 'too many requests' error response.

detailsErrorDetails

Optional details of the error

The ErrorDetails object

Optional details of the error

ElementTypeDescription
errorRefstring

reference to the error occurrence in the internal self-monitoring, logging, etc.

constraintViolationsConstraintViolation[]

A list of constraint violations of input parameters (path, query, request body)

missingScopesstring[]

In case of a 403 - Forbidden response, a list of missing scopes necessary to successfully execute the request

The ConstraintViolation object

Contains information about a constraint violation caused by invalid input.

ElementTypeDescription
pathstring

The path of the parameter that caused the constraint violation

messagestring

The constraint violation description message

parameterLocationstring

Describes the general location of the violating parameter

The element can hold these values
  • PATH
  • QUERY
  • HEADER
  • PAYLOAD_BODY

Response body JSON models

{
  "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "summary": "string",
  "searchSummary": "string",
  "version": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "schemaId": "jira-connection",
  "schemaVersion": "1.0.0",
  "modificationInfo": {
    "createdBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30",
    "createdTime": "string",
    "lastModifiedBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30",
    "lastModifiedTime": "string",
    "lastModifiedReason": "string"
  },
  "resourceContext": {
    "operations": [
      "read"
    ],
    "modifications": {
      "first": true,
      "modifiablePaths": [
        "string"
      ],
      "movable": true,
      "nonModifiablePaths": [
        "string"
      ]
    }
  },
  "value": {
    "autoMonitoring": true
  },
  "owner": {
    "type": "user",
    "id": "string"
  }
}
{
  "error": {
    "code": 1,
    "message": "string",
    "retryAfterSeconds": 1,
    "details": {
      "errorRef": "string",
      "constraintViolations": [
        {
          "path": "string",
          "message": "string",
          "parameterLocation": "PATH"
        }
      ],
      "missingScopes": [
        "string"
      ]
    }
  }
}
Related tags
Platform APIDynatrace Platform