Settings API - General settings schema table
General settings (builtin:dashboards.general)
Configure anonymous access and home dashboard settings.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:dashboards.general |
| environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:dashboards.general |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:dashboards.general | |
| Environment ActiveGate | https://{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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enablePublicSharing | Allow anonymous access | boolean | Allow users to grant anonymous access to dashboards. No sign-in will be required to view those dashboards read-only. | required |
| defaultDashboardList | Home dashboards | list | 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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| UserGroup | User group | text | Show selected dashboard by default for this user group | required |
| Dashboard | Home dashboard | text | Preset dashboard to show as default landing page | required |