Dashboards API - PUT sharing configuration
Updates the sharing configuration of the specified dashboard.
The request consumes an application/json
payload.
PUT | 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 WriteConfig
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 |
body | Dashboard | The JSON body of the request. Contains updated parameters of the dashboard sharing. | body | optional |
Request body objects
The DashboardSharing
object
Sharing configuration of the dashboard.
Element | Type | Description | Required |
---|---|---|---|
enabled | boolean | The dashboard is shared ( | optional |
id | string | The Dynatrace entity ID of the dashboard. | required |
permissions | Dashboard | A list of permissions to access the dashboard. | required |
preset | boolean | If | optional |
publicAccess | Dashboard | Configuration of the anonymous access to the dashboard. | required |
The DashboardAnonymousAccess
object
Configuration of the anonymous access to the dashboard.
Element | Type | Description | Required |
---|---|---|---|
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 | required |
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. | optional |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"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"}}}
Response
Response codes
Code | Type | Description |
---|---|---|
204 | - | Success. The configuration has been updated. Response doesn't have a body. |
400 | Error | Failed. The input is invalid. |
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/shareSettings/validator |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings/validator |
Authentication
To execute this request, you need an access token with WriteConfig
scope.
To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
Code | Type | Description |
---|---|---|
204 | - | Validated. The submitted dashboard share setting is valid. Response doesn't have a body |
400 | Error | Failed. The input is invalid |