• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • General settings

Settings API - General settings schema table

General settings (builtin:dashboards.general)

Configure anonymous access and home dashboard settings.

Schema IDSchema groupsScope
builtin:dashboards.general
  • group:dashboards
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:dashboards.general
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:dashboards.general
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:dashboards.general

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

PropertyLabelTypeDescriptionRequired
enablePublicSharingAllow anonymous accessboolean

Allow users to grant anonymous access to dashboards. No sign-in will be required to view those dashboards read-only.

required
defaultDashboardListHome dashboardslist

Configure home dashboard for selected user group. The selected preset dashboard will be loaded as default landing page for this environment.

required

Request body objects

The UserGroups object
PropertyLabelTypeDescriptionRequired
UserGroupUser grouptext

Show selected dashboard by default for this user group

required
DashboardHome dashboardtext

Preset dashboard to show as default landing page

required