gcloud alpha monitoring dashboards update

NAME
gcloud alpha monitoring dashboards update - update a Cloud Monitoring dashboard
SYNOPSIS
gcloud alpha monitoring dashboards updateDASHBOARD(--config=CONFIG    |--config-from-file=PATH_TO_FILE)[GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update a Monitoring dashboard. The updated dashboard can bespecified as a JSON/YAML value passed in as a string through the--config flag or as a file through the--config-from-file flag.

Note: Etags are used to prevent concurrent updates to the same dashboard. Thelatest etag can be found in adescribe orlistresponse.

For information about the format of a dashboard:https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards

EXAMPLES
To update a dashboard with a YAML config, run:
gcloudalphamonitoringdashboardsupdateMY-DASHBOARD--config='''  displayName: New Dashboard with New Display Name  etag: 40d1040034db4e5a9dee931ec1b12c0d  gridLayout:    widgets:    - text:        content: Hello World  '''

To update a dashboard with a JSON config, run:

gcloudalphamonitoringdashboardsupdateMY-DASHBOARD--config='''  {    "displayName": "New Dashboard with New Display Name",    "etag": "40d1040034db4e5a9dee931ec1b12c0d",    "gridLayout": {      "widgets": [        {          "text": {            "content": "Hello World",          }        }      ]    },  }  '''

To update a dashboard within a specific project, run:

gcloudalphamonitoringdashboardsupdateMY-DASHBOARD--project=MY-PROJECT--config='''  displayName: New Dashboard with New Display Name  etag: 40d1040034db4e5a9dee931ec1b12c0d  gridLayout:    widgets:    - text:        content: Hello World  '''

To update a dashboard with a file, run:

gcloudalphamonitoringdashboardsupdateMY-DASHBOARD--config-from-file=MY-FILE

Sample contents of MY-FILE:

displayName:NewDashboardwithnewDisplayNameetag:40d1040034db4e5a9dee931ec1b12c0dgridLayout:widgets:-text:content:HelloWorld
POSITIONAL ARGUMENTS
Dashboard resource - The dashboard to update. This represents a Cloud resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.

To set theproject attribute:

  • provide the argumentdashboard on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

DASHBOARD
ID of the dashboard or fully qualified identifier for the dashboard.

To set thedashboard attribute:

  • provide the argumentdashboard on the command line.
REQUIRED FLAGS
Exactly one of these must be specified:
--config=CONFIG
Dashboard configuration, in either JSON or YAML format, as a string.
--config-from-file=PATH_TO_FILE
Path to a JSON or YAML file containing the dashboard configuration. Use a fullor relative path to a local file containing the value of config.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses themonitoring/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/monitoring/api/
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudmonitoringdashboardsupdate
gcloudbetamonitoringdashboardsupdate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-22 UTC.