Import & export Custom Dashboards
Effortlessly share your custom dashboards within your organization by importing and exporting them, eliminating the need to recreate them and minimizing overhead.
Import a custom dashboard
In the Dashboards List, select Import.
In the popup that appears, select a .json file to upload or paste your copied JSON. If you want to place the imported dashboard in a specific folder, pick one from the folder selector.
The optional Slug field sets the dashboard's custom URL identifier. If the JSON includes a slug, the field is filled in with it. Change or clear the value as needed.
Select Next. Coralogix checks the JSON before you continue. If it finds problems, they're marked in the editor. See Validation errors.
Review the dashboard summary on the confirmation step, and then select Import to add it to your catalog. The new dashboard is named after the original, with (imported) appended.
To revise your input before confirming, select Back to return to the previous step, your uploaded file, pasted JSON, and folder selection are preserved.
A slug can contain only lowercase letters, numbers, hyphens (-), and underscores (_), and can't start or end with a hyphen or underscore. It must also be unique within your team. If another dashboard already uses the slug, for example the dashboard you exported the JSON from, the field shows This slug already exists, choose a different name. and Next stays unavailable until you change it. To import the dashboard without a custom slug, clear the field.
Validation errors
When you select Next, Coralogix checks the JSON and converts it to the current dashboard format:
- JSON syntax errors appear in the editor as Invalid JSON: followed by the reason.
- Problems in the dashboard definition, such as a missing or duplicate ID, are underlined in the editor at the part of the JSON that causes them. A line under the editor shows 1 problem in the JSON or N problems in the JSON. Select Show to list them. Problems that don't point to a specific part of the JSON are listed under the editor. Next stays unavailable until you edit the JSON.
- Couldn't check this JSON. Try again. means the check didn't run. Select Next again.
Older dashboard formats, such as exports from Terraform, the API, or earlier versions of Custom Dashboards, are converted automatically, and missing IDs are filled in. When that happens, the summary step shows This JSON uses an older format and was converted to the current one. Check the result before you continue. The warning doesn't block the import.
Some problems are found only when you confirm the import. The dialog stays on the summary step and marks each affected widget as <widget name> > <problem>, and Dashboard import failed. Please try again. appears. Fix the JSON, then try again.
The folder in the JSON is ignored. The imported dashboard goes to the folder you select in the dialog.
Export a custom dashboard
Open the Export menu from either of these locations:
- The more actions menu on a dashboard card in the catalog.
- The Export button in the dashboard header.
Both menus offer the same three options:
- Download as PDF: downloads the dashboard as a PDF file. For format and layout options, see Save a dashboard as a PDF.
- Download as JSON: downloads the dashboard definition as a JSON file.
- Copy JSON to clipboard: copies the dashboard JSON to your clipboard.
When the dashboard has changes you have not saved, both JSON options show an Includes unsaved changes note, and the exported JSON reflects what is currently on screen.
Download as JSON and Copy JSON to clipboard are unavailable for dashboards that have not yet been saved.
The exported JSON leaves out the dashboard's folder and custom URL slug, so you can import it into another folder or team without conflicts. If you export a dashboard with unsaved changes, the JSON includes the slug. When you import that JSON, or use it to replace a custom dashboard, the Slug field is filled in with the slug. If you import into the same team as the source dashboard, change the slug or clear the field before you continue.
Additional resources
| Documentation | Custom Dashboards |
Next steps
Learn how to replace a custom dashboard in place by importing JSON.