sonar-dashboards

Retrieves the list of all dashboards registered in Logpresso Sonar. Also returns properties such as each dashboard's GUID, name, theme, display options, owner, and sharing targets.

Command properties

Property	Description
Command type	Driver query
Required permission	Administrator
License usage	Counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

sonar-dashboards

Options

None

Output fields

Field	Type	Description
guid	string	Dashboard GUID
name	string	Dashboard name
description	string	Dashboard description
theme	string	Dashboard theme
is_titleless	boolean	Whether the title bar is hidden
is_bezeless	boolean	Whether the border is hidden
is_controless	boolean	Whether the controls (action buttons) are hidden
owner_guid	string	GUID of the dashboard owner
owner_name	string	Name of the dashboard owner
shared_users	array	List of shared users. Each item is an object with `guid`, `name`, `type`, `read_only`, and `created` fields, where `created` is a string in `yyyy-MM-dd HH:mm:ssZ` format rather than a timestamp value
shared_groups	array	List of shared user groups. Each item is an object with `guid`, `name`, `type`, `read_only`, and `created` fields, where `created` is a string in `yyyy-MM-dd HH:mm:ssZ` format rather than a timestamp value
app_code	string	The code of the app the dashboard belongs to. `null` for dashboards created directly, independent of any app
created	timestamp	Creation date
updated	timestamp	Last modification date

Error codes

Parsing errors

Error code	Message	Description
300170	No permission to list dashboards	Run by an account without administrator permission

Runtime errors

N/A

Description

The sonar-dashboards command targets all dashboards that belong to the same company (tenant), without any filter. Because it runs with administrator permission, all dashboards are returned regardless of owner or sharing settings; to check specific dashboards only, you must chain a search or fields command afterward to filter.

The shared_users and shared_groups fields are arrays of objects that include the GUIDs and names of the users and groups registered in the dashboard's sharing settings.

To clone a dashboard you have queried, use the sonar-clone-dashboards command.

Examples

Retrieve the full list of dashboards
```
sonar-dashboards
```
Returns the properties of every dashboard registered in the system.
Select only the name and owner, sorted by most recently created
```
sonar-dashboards
| fields guid, name, owner_name, created
| sort -created
```
Selects only the GUID, name, and owner of the dashboards, and sorts them in order of most recently created.
Query only dashboards that belong to a specific app
```
sonar-dashboards
| search app_code == "threat-intel"
```
Filters only dashboards created by the app whose app_code is threat-intel.

Change history

The sonar-dashboards command is available in the Sonar 4.0 series starting with 4.0.2609.0, where the command previously provided by the Experimental app was built into Sonar core. On versions without the built-in command, install the Experimental app to use it.