Dashboards API - PUT sharing configuration

Updates the sharing configuration of the specified dashboard.

The request consumes an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

PUT
  • 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
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings

Authentication

To execute this request, you need the Write configuration (WriteConfig) 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
body DashboardSharing

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

body optional

Body format

The DashboardSharing object

Sharing configuration of the dashboard.

Element Type Description Required
preset boolean

If true the dashboard will be marked as preset.

optional
publicAccess DashboardAnonymousAccess required
permissions DashboardSharePermissions[]

A list of permissions to access the dashboard.

required
id string

The Dynatrace entity ID of the dashboard.

required
enabled boolean

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

optional

The DashboardSharePermissions object

Access permissions of the dashboard.

Element Type Description Required
id string

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

Not applicable if the type is set to ALL.

optional
type string

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

The level of the permission:

  • VIEW: The dashboard is shared with read permission.
  • EDIT: The dashboard is shared with edit permission.
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 default value.

required

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/shareSettings/validator
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/shareSettings/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid

Response body

A successful request doesn't return any content.