Method: projects.dashboards.list

Lists the existing dashboards.

This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Google Cloud IAM.

HTTP request

GET https://monitoring.googleapis.com/v1/{parent}/dashboards

Path parameters

Parameters
parent

string

Required. The scope of the dashboards to list. A project scope must be specified in the form of "projects/{project_id_or_number}".

Authorization requires the following Google IAM permission on the specified resource parent:

  • monitoring.dashboards.list

Query parameters

Parameters
pageSize

integer

A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.

pageToken

string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Request body

The request body must be empty.

Response body

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

The dashboards.list request.

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

object (Dashboard)

The list of requested dashboards.

nextPageToken

string

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

Try it!