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

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

Response parametersJSON model

The DashboardSharing object

Sharing configuration of the dashboard.

Element	Type	Description
publicAccess	DashboardPublicShare
published	boolean	If `true` the dashboard is published for everybody in the environment.
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

string

Element	Type	Description
id	string	The ID of the user or group to whom the permission is granted. This is optional for type ALL.
type	string	The type of the permission: `USER`: The dashboard is shared with the specific user. `GROUP`: The dashboard is shared with all users of the specific group. `ALL`: The dashboard is shared via link. Any Authenticated users with the link can view the dashboard. The element can hold these values ALL GROUP USER
permission	string	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

The ID of the user or group to whom the permission is granted. This is optional for type ALL.

type

string

The type of the permission:

USER: The dashboard is shared with the specific user.
GROUP: The dashboard is shared with all users of the specific group.
ALL: The dashboard is shared via link. Any Authenticated users with the link can view the dashboard.

The element can hold these values

ALL
GROUP
USER

permission

string

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

The DashboardPublicShare object

Configuration of the public share of the dashboard.

Element	Type	Description
managementZoneIds	string[]	A list of management zones that can display data on the publicly shared dashboard. Specify the list of management zone IDs here. For the default management zone configured within the dashboard use 'default'. To view the dashboard with the data from a particular management zone, use the respective URL from the urls list.
urls	object	A list of URLs to access the publicly shared dashboard. Each link allows to access data only from respective management zone, listed in the managementZoneIds list. These links are automatically generated by Dynatrace, you can't change them.

Element

Type

Description

managementZoneIds

string[]

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

Specify the list of management zone IDs here. For the default management zone configured within the dashboard use 'default'.

To view the dashboard with the data from a particular management zone, use the respective URL from the urls list.

urls

object

A list of URLs to access the publicly shared dashboard.

Each link allows to access data only from respective management zone, listed in the managementZoneIds list.

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

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