Dashboards Classic API - GET sharing configuration

  • Reference
  • Published Mar 29, 2021

Gets the sharing configuration of the specified dashboard.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required dashboard.

pathRequired

Response

Response codes

CodeTypeDescription
200DashboardSharing

Success

Response body objects

The DashboardSharing object

Sharing configuration of the dashboard.

ElementTypeDescription
enabledboolean

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

idstring

The Dynatrace entity ID of the dashboard.

permissionsDashboardSharePermissions[]

A list of permissions to access the dashboard.

presetboolean

If true the dashboard will be marked as preset.

publicAccessDashboardAnonymousAccess

Configuration of the anonymous access to the dashboard.

The DashboardSharePermissions object

Access permissions of the dashboard.

ElementTypeDescription
idstring

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

Not applicable if the type is set to ALL.

permissionstring

The level of the permission:

  • VIEW: The dashboard is shared with read permission.
  • EDIT: The dashboard is shared with edit permission.
The element can hold these values
  • EDIT
  • VIEW
typestring

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.
The element can hold these values
  • ALL
  • GROUP
  • USER

The DashboardAnonymousAccess object

Configuration of the anonymous access to the dashboard.

ElementTypeDescription
managementZoneIdsstring[]

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.

urlsobject

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.

Response body JSON models

{
  "enabled": "true",
  "id": "a5fca32f-d3ba-4749-b201-5d3cd70b9d22",
  "permissions": [
    {
      "permission": "VIEW",
      "type": "ALL"
    },
    {
      "id": "userid",
      "permission": "VIEW",
      "type": "USER"
    },
    {
      "id": "userid",
      "permission": "EDIT",
      "type": "USER"
    },
    {
      "id": "groupid",
      "permission": "VIEW",
      "type": "GROUP"
    },
    {
      "id": "groupid",
      "permission": "EDIT",
      "type": "GROUP"
    }
  ],
  "preset": "true",
  "publicAccess": {
    "managementZoneIds": [
      "default",
      "2899273953172250973"
    ],
    "urls": {
      "2899273953172250973": "https://mytenantid.live.dynatrace.com/e/1/dashboards/a5fca32f-d3ba-4749-b201-5d3cd70b9d22?auth=SL5wTvCbaM2lwpew23234",
      "default": "https://mytenantid.live.dynatrace.com/e/1/dashboards/a5fca32f-d3ba-4749-b201-5d3cd70b9d22?auth=9yPpSI-M-3434Irz8yc8U"
    }
  }
}