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": {
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"custom": {
"collapsed": false,
"color": {
"predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
},
"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": {
"dynamic": {
"interpretation": "INTERPRETATION_UNSPECIFIED",
"query": {
"logs": {
"aggregation": [
{
"average": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
],
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"filters": [
{
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"luceneQuery": {
"value": "<string>"
}
}
},
"queryDefinitions": [
{
"id": "<string>",
"query": {
"logs": {
"aggregation": [
{
"average": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
],
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"filters": [
{
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"luceneQuery": {
"value": "<string>"
}
}
},
"name": "<string>"
}
],
"timeFrame": {
"relativeTimeFrame": "<string>"
},
"visualization": {
"hexagonBins": {
"allowAbbreviation": false,
"categoryFields": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"customUnit": "<string>",
"decimalPrecision": 2,
"legend": {
"columns": [
1,
2,
6
],
"groupByQuery": true,
"isVisible": true,
"placement": "LEGEND_PLACEMENT_UNSPECIFIED"
},
"legendBy": "LEGEND_BY_UNSPECIFIED",
"max": 150000,
"min": 0,
"thresholdType": "THRESHOLD_TYPE_UNSPECIFIED",
"thresholds": [
{
"color": "<string>",
"from": 123,
"label": "<string>"
}
],
"unit": "UNIT_UNSPECIFIED",
"valueField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
}
},
"description": "<string>",
"id": {
"value": "<string>"
},
"reference": {
"dashboardId": "<string>",
"widgetId": {
"value": "<string>"
}
},
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"oneMinute": {},
"relativeTimeFrame": "<string>",
"actions": [
{
"dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"queryId": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"color": "ANNOTATION_COLOR_UNSPECIFIED",
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"allWidgets": {}
},
"source": {
"metrics": {
"intervalResolution": {
"auto": {
"maximumDataPoints": 500,
"minimumInterval": "<string>"
},
"useAdvancedLimit": true
},
"labels": [
"<string>"
],
"messageTemplate": "<string>",
"orientation": "ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED",
"promqlQuery": {
"value": "<string>"
},
"strategy": {
"startTimeMetric": {}
}
}
}
}
],
"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>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"folderId": {
"value": "<string>"
},
"folderPath": {
"segments": [
"<string>"
]
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"slugName": "system-health-monitoring",
"variables": [
{
"definition": {
"multiSelect": {
"selected": [
"<string>"
],
"selection": {
"all": {}
},
"selectionOptions": {
"selectionType": "SELECTION_TYPE_UNSPECIFIED"
},
"source": {
"constantList": {
"values": [
"<string>"
]
}
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED"
}
},
"description": "<string>",
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED",
"name": "<string>"
}
],
"variablesV2": [
{
"description": "<string>",
"displayFullRow": true,
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
"id": {
"value": "<string>"
},
"name": "<string>",
"source": {
"query": {
"logsQuery": {
"type": {
"fieldName": {
"logRegex": "<string>"
}
}
},
"allOption": {
"includeAll": true,
"label": "<string>"
},
"refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
"valueDisplayOptions": {
"labelRegex": "<string>",
"valueRegex": "<string>"
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED"
}
},
"value": {
"interval": {
"value": {
"label": "<string>",
"value": "<string>"
}
}
}
}
]
},
"requestId": "<string>",
"isLocked": true
}
'{}No description available
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": {
"layout": {
"sections": [
{
"id": {
"value": "<string>"
},
"options": {
"custom": {
"collapsed": false,
"color": {
"predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
},
"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": {
"dynamic": {
"interpretation": "INTERPRETATION_UNSPECIFIED",
"query": {
"logs": {
"aggregation": [
{
"average": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
],
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"filters": [
{
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"luceneQuery": {
"value": "<string>"
}
}
},
"queryDefinitions": [
{
"id": "<string>",
"query": {
"logs": {
"aggregation": [
{
"average": {
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
],
"dataModeType": "DATA_MODE_TYPE_HIGH_UNSPECIFIED",
"filters": [
{
"field": "<string>",
"observationField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
],
"groupBy": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"luceneQuery": {
"value": "<string>"
}
}
},
"name": "<string>"
}
],
"timeFrame": {
"relativeTimeFrame": "<string>"
},
"visualization": {
"hexagonBins": {
"allowAbbreviation": false,
"categoryFields": [
{
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
],
"customUnit": "<string>",
"decimalPrecision": 2,
"legend": {
"columns": [
1,
2,
6
],
"groupByQuery": true,
"isVisible": true,
"placement": "LEGEND_PLACEMENT_UNSPECIFIED"
},
"legendBy": "LEGEND_BY_UNSPECIFIED",
"max": 150000,
"min": 0,
"thresholdType": "THRESHOLD_TYPE_UNSPECIFIED",
"thresholds": [
{
"color": "<string>",
"from": 123,
"label": "<string>"
}
],
"unit": "UNIT_UNSPECIFIED",
"valueField": {
"keypath": [
"<string>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
}
}
},
"description": "<string>",
"id": {
"value": "<string>"
},
"reference": {
"dashboardId": "<string>",
"widgetId": {
"value": "<string>"
}
},
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
},
"name": "Example Name",
"oneMinute": {},
"relativeTimeFrame": "<string>",
"actions": [
{
"dataSource": "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED",
"definition": {
"customAction": {
"url": "<string>"
}
},
"id": "<string>",
"name": "<string>",
"queryId": "<string>",
"shouldOpenInNewWindow": true,
"widgetId": "<string>"
}
],
"annotations": [
{
"color": "ANNOTATION_COLOR_UNSPECIFIED",
"description": "<string>",
"enabled": true,
"id": "<string>",
"name": "<string>",
"scope": {
"allWidgets": {}
},
"source": {
"metrics": {
"intervalResolution": {
"auto": {
"maximumDataPoints": 500,
"minimumInterval": "<string>"
},
"useAdvancedLimit": true
},
"labels": [
"<string>"
],
"messageTemplate": "<string>",
"orientation": "ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED",
"promqlQuery": {
"value": "<string>"
},
"strategy": {
"startTimeMetric": {}
}
}
}
}
],
"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>"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"operator": {
"equals": {
"selection": {
"all": {}
}
}
}
}
}
}
],
"folderId": {
"value": "<string>"
},
"folderPath": {
"segments": [
"<string>"
]
},
"id": "GZLHSeqelCbD3I7HbIDtL",
"slugName": "system-health-monitoring",
"variables": [
{
"definition": {
"multiSelect": {
"selected": [
"<string>"
],
"selection": {
"all": {}
},
"selectionOptions": {
"selectionType": "SELECTION_TYPE_UNSPECIFIED"
},
"source": {
"constantList": {
"values": [
"<string>"
]
}
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED"
}
},
"description": "<string>",
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED",
"name": "<string>"
}
],
"variablesV2": [
{
"description": "<string>",
"displayFullRow": true,
"displayName": "<string>",
"displayType": "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED",
"id": {
"value": "<string>"
},
"name": "<string>",
"source": {
"query": {
"logsQuery": {
"type": {
"fieldName": {
"logRegex": "<string>"
}
}
},
"allOption": {
"includeAll": true,
"label": "<string>"
},
"refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
"valueDisplayOptions": {
"labelRegex": "<string>",
"valueRegex": "<string>"
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED"
}
},
"value": {
"interval": {
"value": {
"label": "<string>",
"value": "<string>"
}
}
}
}
]
},
"requestId": "<string>",
"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.
API key authentication
This is a request sent to update an existing dashboard with new information
This is a response received when the dashboard is successfully updated
Was this page helpful?