Dashboards API - PUT sharing configuration

Updates the sharing configuration of the specified dashboard.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/shareSettings
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
idstring

The ID of the required dashboard.

pathrequired
bodyDashboardSharing

The JSON body of the request. Contains updated parameters of the dashboard sharing.

bodyoptional

Request body objects

The DashboardSharing object

Sharing configuration of the dashboard.

ElementTypeDescriptionRequired
enabledboolean

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

optional
idstring

The Dynatrace entity ID of the dashboard.

required
permissionsDashboardSharePermissions[]

A list of permissions to access the dashboard.

required
presetboolean

If true the dashboard will be marked as preset.

optional
publicAccessDashboardAnonymousAccess

Configuration of the anonymous access to the dashboard.

required

The DashboardSharePermissions object

Access permissions of the dashboard.

ElementTypeDescriptionRequired
idstring

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

Not applicable if the type is set to ALL.

optional
permissionstring

The level of the permission:

  • VIEW: The dashboard is shared with read permission.
  • EDIT: The dashboard is shared with edit permission.
  • EDIT
  • VIEW
required
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.
  • ALL
  • GROUP
  • USER
required

The DashboardAnonymousAccess object

Configuration of the anonymous access to the dashboard.

ElementTypeDescriptionRequired
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.

required
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.

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

CodeTypeDescription
204-

Success. The configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/shareSettings/validator
Environment ActiveGatehttps://{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

CodeTypeDescription
204-

Validated. The submitted dashboard share setting is valid. Response doesn't have a body

400ErrorEnvelope

Failed. The input is invalid

Related topics