Skip to main content
Theme
Home

Create a new dashboard

POSThttps://api.coralogix.com/mgmt/openapi/5/dashboards/dashboards/v1

Creates a new dashboard.

Requires the following permissions:

  • team-dashboards:Update

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

This is a request used to create a new custom dashboard

    accessPolicy#string

    JSON string representing the access policy for this dashboard. Defines granular permissions for users and groups.

    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 represents the structure and configuration of a Coralogix Custom Dashboard.

    isLocked#boolean

    The is locked.

    requestId#stringrequired

    The request id.

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

Response

application/json

This is a response received when a custom dashboard is successfully created

    dashboardId#string

    The dashboard id.

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