Dashboards API - GET sharing configuration
Gets the sharing configuration of the specified dashboard.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | 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}:9999/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
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required dashboard. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | DashboardSharing | Success |
Response body objects
The DashboardSharing object
Sharing configuration of the dashboard.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The dashboard is shared ( |
| id | string | The Dynatrace entity ID of the dashboard. |
| permissions | DashboardSharePermissions[] | A list of permissions to access the dashboard. |
| preset | boolean | If |
| publicAccess | DashboardAnonymousAccess | Configuration of the anonymous access to the dashboard. |
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 |
| 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. |
Response body JSON model
1{2 "enabled": "true",3 "id": "a5fca32f-d3ba-4749-b201-5d3cd70b9d22",4 "permissions": [5 {6 "permission": "VIEW",7 "type": "ALL"8 },9 {10 "id": "userid",11 "permission": "VIEW",12 "type": "USER"13 },14 {15 "id": "userid",16 "permission": "EDIT",17 "type": "USER"18 },19 {20 "id": "groupid",21 "permission": "VIEW",22 "type": "GROUP"23 },24 {25 "id": "groupid",26 "permission": "EDIT",27 "type": "GROUP"28 }29 ],30 "preset": "true",31 "publicAccess": {32 "managementZoneIds": [33 "default",34 "2899273953172250973"35 ],36 "urls": {37 "2899273953172250973": "https://mytenantid.live.dynatrace.com/e/1/dashboards/a5fca32f-d3ba-4749-b201-5d3cd70b9d22?auth=SL5wTvCbaM2lwpew23234",38 "default": "https://mytenantid.live.dynatrace.com/e/1/dashboards/a5fca32f-d3ba-4749-b201-5d3cd70b9d22?auth=9yPpSI-M-3434Irz8yc8U"39 }40 }41}