Skip to main content
Create a new dashboard
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/latest/v1/dashboards/dashboards \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dashboard": {
    "absoluteTimeFrame": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "actions": [
      {
        "dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
        "definition": {
          "customAction": {
            "url": "<string>"
          }
        },
        "id": "<string>",
        "name": "<string>",
        "shouldOpenInNewWindow": true,
        "widgetId": "<string>"
      }
    ],
    "annotations": [
      {
        "description": "<string>",
        "enabled": true,
        "id": "<string>",
        "name": "<string>",
        "scope": {
          "specificWidgets": {
            "widgetIds": [
              "<any>"
            ]
          }
        },
        "source": {
          "dataprime": {
            "dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
            "labelFields": [
              "<any>"
            ],
            "messageTemplate": "<string>",
            "orientation": "ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED",
            "query": {
              "text": "<any>"
            },
            "strategy": {
              "instant": "<any>"
            }
          }
        }
      }
    ],
    "description": "Sample description",
    "filters": [
      {
        "collapsed": true,
        "displayName": "<string>",
        "enabled": true,
        "source": {
          "logs": {
            "field": "<string>",
            "observationField": {
              "keypath": "<any>",
              "scope": "<any>"
            },
            "operator": {
              "equals": "<any>"
            }
          }
        }
      }
    ],
    "fiveMinutes": {},
    "folderId": {
      "value": "<any>"
    },
    "id": "GZLHSeqelCbD3I7HbIDtL",
    "layout": {
      "sections": [
        {
          "id": {
            "value": "<any>"
          },
          "options": {
            "internal": {}
          },
          "rows": [
            {}
          ]
        }
      ]
    },
    "name": "Example Name",
    "slugName": "system-health-monitoring",
    "variables": [
      {
        "definition": {
          "constant": {
            "value": "<string>"
          }
        },
        "description": "<string>",
        "displayName": "<string>",
        "displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED",
        "name": "<string>"
      }
    ],
    "variablesV2": [
      {
        "description": "<string>",
        "displayFullRow": true,
        "displayName": "<string>",
        "displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
        "name": "<string>",
        "source": {
          "textbox": {
            "defaultValue": {
              "defaultRegexValue": "<any>"
            }
          }
        },
        "value": {
          "interval": {
            "value": {
              "label": "<any>",
              "value": "<any>"
            }
          }
        }
      }
    ]
  },
  "isLocked": true,
  "requestId": "<string>"
}'
{
  "dashboardId": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

This is a request used to create a new custom dashboard

​
dashboard
object
required

Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.

  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
  • Dashboard
​
requestId
string
required
​
isLocked
boolean

Response

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

​
dashboardId
string