Method: dashboards.list

Full name: projects.locations.instances.dashboards.list

List all dashboards.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{parent}/dashboards

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of dashboards. Format: projects/{project}/locations/{region}/instances/{instance}

Query parameters

Parameters
pageSize

integer

The maximum number of dashboards to return. The service may return fewer than this value.
pageToken

string

A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.
view

enum (DashboardView)

View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

Request body

The request body must be empty.

Response body

Response message for listing dashboards.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "dashboards": [
    {
      object (Dashboard)
    }
  ],
  "next_page_token": string
}
Fields
dashboards[]

object (Dashboard)

The dashboards from the specified chronicle instance.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.dashboards.list

For more information, see the IAM documentation.