Dashboards API - GET sharing configuration

Gets the sharing configuration of the specified dashboard.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/shareSettings
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the required dashboard.

path required

Response

Response codes

Code Description
200

Success

Response body

The DashboardSharing object

Sharing configuration of the dashboard.

Element Type Description
preset boolean

If true the dashboard will be marked as preset.

publicAccess DashboardAnonymousAccess
permissions DashboardSharePermissions[]

A list of permissions to access the dashboard.

id string

The Dynatrace entity ID of the dashboard.

enabled boolean

The dashboard is shared (true) or private (false).

The DashboardSharePermissions object

Access permissions of the dashboard.

Element Type Description
id string

The ID of the user or group to whom the permission is granted.

Not applicable if the type is set to ALL.

type string

The type of the permission:

  • USER: The dashboard is shared with the specified user.
  • GROUP: The dashboard is shared with all users of the specified group.
  • ALL: The dashboard is shared via link. Any authenticated user with the link can view the dashboard.
permission string

The level of the permission:

  • VIEW: The dashboard is shared with read permission.
  • EDIT: The dashboard is shared with edit permission.

The DashboardAnonymousAccess object

Configuration of the anonymous access to the dashboard.

Element Type Description
managementZoneIds string[]

A list of management zones that can display data on the publicly shared dashboard.

Specify management zone IDs here. For each management zone you specify Dynatrace generates an access link. You can access them in the urls list.

To share the dashboard with its default management zone, use the default value.

urls object

A list of URLs for anonymous access to the dashboard.

Each link grants access to data from the specific management zone, listed in the in the managementZoneIds list.

These links are automatically generated by Dynatrace, you can't change them.