Try it free

Settings API - DPS Advisor — Subscription API connection schema table

  • Published Jun 09, 2026

DPS Advisor — Subscription API connection (app:my.dps.advisor:dps-advisor-subscription-api-connection)

OAuth 2.0 client credentials used by the DPS Advisor backend function to read commit and cost data from the Dynatrace Account Management Subscription API.

Schema IDSchema groupsScope
app:my.dps.advisor:dps-advisor-subscription-api-connection-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:my.dps.advisor:dps-advisor-subscription-api-connection
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:my.dps.advisor:dps-advisor-subscription-api-connection
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:my.dps.advisor:dps-advisor-subscription-api-connection

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Connection name
name
text

A human-readable label for this connection (e.g. prod).

Required
Account URN
accountUrn
text

The Dynatrace account URN (urn:dtaccount:) the OAuth client is registered against.

Required
OAuth Client ID
clientId
text

OAuth 2.0 client ID issued by Dynatrace SSO with the required Subscription API scopes.

Required
OAuth Client Secret
clientSecret
secret

OAuth 2.0 client secret. Stored encrypted by the Dynatrace Settings service and never returned in clear text.

Required
OAuth Scopes
scope
text

Space-separated list of scopes to request from SSO. Must match what was granted to the OAuth client in Account Management. Required for the token exchange — Dynatrace SSO returns invalid_request if this is omitted. Example: account-idm-read account-env-read.

Required
Token URL
tokenUrl
text

Dynatrace SSO token endpoint. Defaults to the production endpoint; only override for sprint or staging tenants.

Required
Account Management API base URL
apiBaseUrl
text

Base URL of the Dynatrace Account Management API. Defaults to the production endpoint.

Required