Replace a dashboard

PUThttps://api.eu1.coralogix.com/mgmt/openapi/5/dashboards/dashboards/v1

Replaces the dashboard definition, the access policy, or both. Sending dashboard requires team-dashboards:Update. Changing the access policy requires team-dashboards:UpdateAccessPolicy together with team-dashboards:Update on the same dashboard, or the break-glass access-policies:UpdateAll. Without that, an accessPolicy that differs from the stored policy is rejected with 403 and nothing in the request is stored; one equal to the stored policy is accepted and leaves it unchanged. Policies are compared as JSON, so formatting alone is not a change. A request that sends only accessPolicy creates no new dashboard version.

Requires the following permissions:

team-dashboards:Update
team-dashboards:UpdateAccessPolicy
access-policies:UpdateAll

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

Replaces the dashboard definition, the access policy, or both. A part that is present replaces the stored value as a whole; a part that is omitted is left unchanged. At least one of dashboard and accessPolicy is required.

accessPolicy#string

JSON string with the access policy of this dashboard, which defines granular permissions for users and groups. Changing it requires team-dashboards:UpdateAccessPolicy together with team-dashboards:Update on this dashboard, or the break-glass access-policies:UpdateAll. Without that, a value that differs from the stored policy is rejected with 403, and the stored policy sent back unchanged is accepted.

Possible values: <= 65536 characters, Value must match regular expression ^[\s\S]*$

Example:

{"version":"2025-01-01","default":{"permissions":{"team-dashboards:Read":"grant","team-dashboards:Update":"deny","team-dashboards:ReadAccessPolicy":"grant","team-dashboards:UpdateAccessPolicy":"deny"}},"rules":[]}

dashboard# object

The complete dashboard definition to store. Requires team-dashboards:Update.

dashboardId#string

The id of the dashboard to change. Required when dashboard is omitted; when sent together with dashboard it must equal dashboard.id.

Possible values: >= 21 characters and <= 21 characters, Value must match regular expression ^[\s\S]*$

Example: GZLHSeqelCbD3I7HbIDtL

isLocked#boolean

Whether the dashboard is locked against edits. Ignored when dashboard is omitted.

requestId#stringrequired

Idempotency key for the replace request, used to prevent duplicate updates.

Possible values: non-empty and <= 128 characters, Value must match regular expression ^[\s\S]*$

Response