Returns a list of dashboards with a specific dashboard group ID.


oci dashboard-service dashboard list-dashboards [OPTIONS]

Required Parameters

--dashboard-group-id [text]

The OCID of the dashboard group that the dashboard belongs to.

Optional Parameters


Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--display-name [text]

A case-sensitive filter that returns resources that match the entire display name specified.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--id [text]

The OCID of the dashboard.

--lifecycle-state [text]

A filter that returns dashboard resources that match the lifecycle state specified.

Accepted values are:

--limit [integer]

The maximum number of items to return.

--opc-cross-region [text]

To identify if the call is cross-regional. In CRUD calls for a resource, to identify that the call originates from different region, set the CrossRegionIdentifierHeader parameter to a region name (ex - US-ASHBURN-1) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned.

--page [text]

The page token representing the page at which to start retrieving results. This value is usually retrieved from a previous list call.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Accepted values are:

displayName, timeCreated
--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC).

Accepted values are:


Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #

    dashboard_group_id=$(oci dashboard-service dashboard-group create --compartment-id $compartment_id --query --raw-output)

    oci dashboard-service dashboard list-dashboards --dashboard-group-id $dashboard_group_id