Skip to main content
Theme
Home

Get a dashboard

GEThttps://api.eu1.coralogix.com/mgmt/openapi/5/dashboards/dashboards/v1/{dashboard_id}

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.

Requires the following permissions:

  • team-dashboards:Read
  • team-dashboards:ReadAccessPolicy
  • access-policies:ReadAll

Authorizations

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

Request​

Path Parameters

    dashboard_id# stringrequired

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

    The dashboard id.

Response

application/json

This is a response containing the requested dashboard

    accessPolicy#string

    JSON string with the access policy of this dashboard. Present only when the caller holds team-dashboards:ReadAccessPolicy together with team-dashboards:Read on this dashboard, or the break-glass access-policies:ReadAll.

    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":[]}
    authorId#string

    The author id.

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

    authorName#string

    The author name.

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

    createdAt#date-time

    Creation timestamp.

    Possible values: >= 20 characters and <= 30 characters

    createdOriginType#TokenOriginType

    Token origin type.

    Possible values: [TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API]

    The dashboard definition. Omitted when the caller lacks team-dashboards:Read.

    isLocked#boolean

    The is locked.

    lockerAuthorId#string

    The locker author id.

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

    lockerName#string

    The locker name.

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

    What the caller may do with this dashboard.

    Map of resolved widget references for widgets with references in the dashboard

    updatedAt#date-time

    Last-updated timestamp.

    Possible values: >= 20 characters and <= 30 characters

    updatedOriginType#TokenOriginType

    Token origin type.

    Possible values: [TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API]

    updaterAuthorId#string

    The updater author id.

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

    updaterName#string

    The updater name.

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