Skip to main content
Replace a dashboard
curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/5/dashboards/dashboards/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dashboard": {
    "absoluteTimeFrame": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "fifteenMinutes": {},
    "layout": {
      "sections": [
        {
          "id": {
            "value": "<string>"
          },
          "options": {
            "custom": {
              "collapsed": false,
              "color": {},
              "description": "<string>",
              "name": "<string>",
              "repetitiveVar": {
                "name": "pod_name"
              }
            }
          },
          "rows": [
            {
              "appearance": {
                "height": 123
              },
              "id": {
                "value": "<string>"
              },
              "widgets": [
                {
                  "appearance": {
                    "width": 123
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "definition": {
                    "barChart": {
                      "colorScheme": "classic",
                      "colorsBy": {
                        "aggregation": {}
                      },
                      "customUnit": "mph",
                      "decimal": 4,
                      "decimalPrecision": false,
                      "groupNameTemplate": "Result - {{ variable }}",
                      "hashColors": false,
                      "legend": {
                        "columns": [
                          "LEGEND_COLUMN_MIN",
                          "LEGEND_COLUMN_MAX",
                          "LEGEND_COLUMN_NAME"
                        ],
                        "groupByQuery": true,
                        "isVisible": true
                      },
                      "maxBarsPerChart": 20,
                      "query": {
                        "dataprime": {
                          "dataprimeQuery": {
                            "text": "<string>"
                          },
                          "filters": [
                            {
                              "logs": {
                                "field": "<string>",
                                "observationField": {
                                  "keypath": [
                                    "<string>"
                                  ]
                                },
                                "operator": "<unknown>"
                              }
                            }
                          ],
                          "groupNames": [
                            "<string>"
                          ],
                          "stackedGroupName": "<string>",
                          "timeFrame": {
                            "absoluteTimeFrame": {
                              "from": "2023-11-07T05:31:56Z",
                              "to": "2023-11-07T05:31:56Z"
                            }
                          }
                        }
                      },
                      "stackDefinition": {
                        "maxSlicesPerBar": 123,
                        "stackNameTemplate": "<string>"
                      },
                      "xAxis": {
                        "time": {
                          "bucketsPresented": 123,
                          "interval": "<string>"
                        }
                      },
                      "yAxisMax": 1000,
                      "yAxisMin": -1000
                    }
                  },
                  "description": "<string>",
                  "id": {
                    "value": "<string>"
                  },
                  "reference": {
                    "dashboardId": "<string>",
                    "widgetId": {
                      "value": "<string>"
                    }
                  },
                  "title": "<string>",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ]
            }
          ]
        }
      ]
    },
    "name": "Example Name",
    "actions": [
      {
        "definition": {
          "customAction": {
            "url": "<string>"
          }
        },
        "id": "<string>",
        "name": "<string>",
        "queryId": "<string>",
        "shouldOpenInNewWindow": true,
        "widgetId": "<string>"
      }
    ],
    "annotations": [
      {
        "description": "<string>",
        "enabled": true,
        "id": "<string>",
        "name": "<string>",
        "scope": {
          "allWidgets": {}
        },
        "source": {
          "dataprime": {
            "labelFields": [
              {
                "keypath": [
                  "<string>"
                ]
              }
            ],
            "messageTemplate": "<string>",
            "query": {
              "text": "<string>"
            },
            "strategy": {
              "duration": {
                "durationField": {
                  "keypath": [
                    "<string>"
                  ]
                },
                "startTimestampField": {
                  "keypath": [
                    "<string>"
                  ]
                }
              }
            }
          }
        }
      }
    ],
    "description": "Sample description",
    "filters": [
      {
        "collapsed": true,
        "displayName": "<string>",
        "enabled": true,
        "id": {
          "value": "<string>"
        },
        "scope": {
          "allWidgets": {},
          "specificWidgets": {
            "widgetIds": [
              {
                "value": "<string>"
              }
            ]
          }
        },
        "source": {
          "logs": {
            "field": "<string>",
            "observationField": {
              "keypath": [
                "<string>"
              ]
            },
            "operator": {
              "equals": {
                "selection": {
                  "all": {}
                }
              }
            }
          }
        }
      }
    ],
    "folderId": {
      "value": "<string>"
    },
    "folderPath": {
      "segments": [
        "<string>"
      ]
    },
    "id": "GZLHSeqelCbD3I7HbIDtL",
    "slugName": "system-health-monitoring",
    "variables": [
      {
        "definition": {
          "constant": {
            "value": "<string>"
          }
        },
        "description": "<string>",
        "displayName": "<string>",
        "name": "<string>"
      }
    ],
    "variablesV2": [
      {
        "description": "<string>",
        "displayFullRow": true,
        "displayName": "<string>",
        "id": {
          "value": "<string>"
        },
        "name": "<string>",
        "source": {
          "query": {
            "dataprimeQuery": {
              "type": {
                "queryText": {
                  "query": {
                    "text": "<string>"
                  }
                }
              }
            },
            "allOption": {
              "includeAll": true,
              "label": "<string>"
            },
            "valueDisplayOptions": {
              "labelRegex": "<string>",
              "valueRegex": "<string>"
            }
          }
        },
        "value": {
          "interval": {
            "value": {
              "label": "<string>",
              "value": "<string>"
            }
          }
        }
      }
    ]
  },
  "requestId": "<string>",
  "accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}",
  "isLocked": true
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

This is a request sent to update an existing dashboard with new information

dashboard
Dashboard · object
required

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

requestId
string
required

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

accessPolicy
string

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

Required string length: 1 - 65536
Pattern: ^[\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\":[]}"

isLocked
boolean

The is locked.

Response

This is a response received when the dashboard is successfully updated