- NAME
-
- gcloud api-gateway apis update - update an API Gateway API
- SYNOPSIS
-
-
gcloud api-gateway apis updateAPI[--async] [--display-name=DISPLAY_NAME] [--update-labels=[KEY=VALUE, …]] [--clear-labels|--remove-labels=[KEY, …]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Update an API Gateway API.
NOTE: Only the display name and labels attributes are mutable on an API.
- EXAMPLES
- To update the display name of an API, run:
gcloud api-gateway apis update my-api --display-name = "New Display Name"NOTE: Only the display name and labels attributes are mutable on an API.
- POSITIONAL ARGUMENTS
-
- Api resource - Name for API which updated. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
To set the
projectattribute:- provide the argument
apion the command line with a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
To set the
locationattribute:- provide the argument
apion the command line with a fully specified name; - Location for API and API Configs. Defaults to global.
This must be specified.
-
API - ID of the api or fully qualified identifier for the api.
To set the
apiattribute:- provide the argument
apion the command line.
- provide the argument
- provide the argument
- Api resource - Name for API which updated. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
- FLAGS
-
-
--async - Return immediately, without waiting for the operation in progress to complete.
-
--display-name=DISPLAY_NAME - Human readable name which can optionally be supplied.
-
--update-labels=[KEY=VALUE,…] - List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers. - At most one of these can be specified:
-
--clear-labels - Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud api-gateway apis update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud api-gateway apis update --clear-labels --update-labels foo = bar,baz = qux -
--remove-labels=[KEY,…] - List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labelsis also specified then--update-labelsis applied first.
-
-
- 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 helpfor details. - NOTES
- These variants are also available:
gcloud alpha api-gateway apis updategcloud beta api-gateway apis update
gcloud api-gateway apis update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

