Dashboard service
Manage your dashboards.
Overview
The Dashboard service API manages Coralogix dashboards: it lets you create, retrieve, update, delete, and organize dashboards, pin them to favorites, and look up a catalog of every dashboard the caller can see. A dashboard is a JSON payload describing a Layout of Sections, each containing Rows of Widgets, parameterized by Variables and annotated with Annotations. The same payload is consumed by Create and Replace operations and returned by Get.
Copy a dashboard
This use case demonstrates how to duplicate an existing dashboard by retrieving its configuration and posting it as a new dashboard.
Validate a dashboard and return issues
Checks a dashboard definition or an existing dashboard by id and returns validation issues without persisting changes.
Replace a dashboard
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.
Create a new dashboard
Creates a new dashboard.
Get dashboard catalog
Returns the dashboards the caller may access. A caller with `team-dashboards:Read` receives every dashboard it may view. `team-dashboards:ReadAccessPolicy` requires `team-dashboards:Read` on the same dashboard and grants nothing on its own, so a dashboard for which the caller holds only `team-dashboards:ReadAccessPolicy` is not listed. Only `access-policies:ReadAll` is break-glass: a caller without `team-dashboards:Read` who holds it receives every dashboard, each reduced to `id`, `name`, `slugName`, `folder`, `isLocked` and `permissions`.
Get a dashboard by URL slug
Returns the dashboard associated with the specified slug. A caller with `team-dashboards:Read` on this dashboard receives the dashboard definition and its metadata, and the access policy too if it also holds `team-dashboards:ReadAccessPolicy` on this dashboard. `team-dashboards:ReadAccessPolicy` requires `team-dashboards:Read` on the same dashboard and grants nothing on its own: a caller that holds it without `team-dashboards:Read` and without `access-policies:ReadAll` gets `403`. Only `access-policies:ReadAll` is break-glass: a caller without `team-dashboards:Read` who holds it receives only the access policy, the lock state and the `permissions` object.
Get a dashboard
Returns the details of the specified dashboard. A caller with `team-dashboards:Read` on this dashboard receives the dashboard definition and its metadata, and the access policy too if it also holds `team-dashboards:ReadAccessPolicy` on this dashboard. `team-dashboards:ReadAccessPolicy` requires `team-dashboards:Read` on the same dashboard and grants nothing on its own: a caller that holds it without `team-dashboards:Read` and without `access-policies:ReadAll` gets `403`. Only `access-policies:ReadAll` is break-glass: a caller without `team-dashboards:Read` who holds it receives only the access policy, the lock state and the `permissions` object.
Delete a dashboard
Deletes the dashboard with the specified ID.
Replace the default dashboard
Sets the specified dashboard as the default.
Assign a dashboard to a folder
Assigns the dashboard to a folder.
Add dashboard to favorites
Pins the specified dashboard.
Remove dashboard from favorites
Unpins the specified dashboard.