Documentation forSolarWinds Platformand Orion Platform

Import and export modern dashboards

This topic applies to all SolarWinds Platform products.

Share your dashboards with wider audience, such as the THWACK community, back up your custom dashboards, or re-import SolarWinds out-of-the-box dashboards in case the dashboard configuration is damaged.

Requirements

  • You need to have the SWQL Studio installed or use PowerShell.

  • Your user account needs to have sufficient privileges:

    • Accounts with administrator rights can export/import any dashboards.

    • Accounts with the Manage Dashboards right can only export/import dashboards created by themselves.

    • Accounts without Manage Dashboards cannot export/import any dashboards.

    If you don't have sufficient rights, you won't be able to complete the export/import query and will get a Permission Denied error.

Export a modern dashboard

  1. Create your dashboard as a user dashboard using SolarWinds Platform Web Console.

  2. Note the dashboard ID. It is the number at the end of your SolarWinds Platform Web Console URL, such as: https://hostname/apps/platform/dashboard/3

  3. Open SWQL Studio and search for the Orion.Dashboard.Instances entity.

  4. Expand the Orion.Dashboards.Instances entity and click the Export verb.

  5. Type the dashboard ID into the dashboardID text box in the Orion.Dashboards.Instances.Export pane and click Invoke to export the dashboard.

    The dashboard definition is displayed as a JSON string below the Invoke button in the SWQL Studio. The dashboard definition is the content between <Return>...</Return> tags.

  6. Copy the resulting JSON string into a file.

Import a modern dashboard

  1. Open SWQL Studio and search for the Orion.Dashboard.Instances entity.

  2. Expand the Orion.Dashboards.Instances entity and click the Import verb.

  3. Paste the exported JSON string (the characters between the <Return>...</Return> tags of the dashboard definition) into the definition text box in Orion.Dashboards.Instances.Export pane and click Invoke to import the dashboard.

    The dashboard will now be available in your SolarWinds Platform Web Console.

All imported dashboards are private and owned by the account logged into SWIS.

Identification of dashboard definitions

Each exported dashboard (and widgets) obtains a unique key. During the import, dashboards with the same unique key as an already available dashboard overwrite the original dashboard.

To share an update for a dashboard, ensure that the updated dashboard and widgets to be imported have the same unique keys as the dashboards in your SolarWinds Platform.

Import and export modern dashboards using PowerShell

You can use PowerShell to invoke the import and export verbs with required parameters. See Using SolarWinds Information Service from PowerShell.

Verb Required parameter
Import dashboardId
Export definition