gcloud alpha api-gateway api-configs update

NAME
gcloud alpha api-gateway api-configs update - update an API Gateway API config
SYNOPSIS
gcloud alpha api-gateway api-configs update(API_CONFIG :--api=API)[--async][--display-name=DISPLAY_NAME][--update-labels=[KEY=VALUE,…]][--clear-labels    |--remove-labels=[KEY,…]][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update an API Gateway API config.

NOTE: Only the name and labels may be updated on an API config.

EXAMPLES
To update the display name of an API config, run:
gcloudalphaapi-gatewayapi-configsupdatemy-config--api=my-api--display-name="New Display Name"

NOTE: Only the display name and labels attributes are mutable on an API config.

POSITIONAL ARGUMENTS
Api config resource - Name for API Config which will be updated. The argumentsin this group can be used to specify the attributes of this resource. (NOTE)Some attributes are not given arguments in this group but can be set in otherways.

To set theproject attribute:

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

To set thelocation attribute:

  • provide the argumentapi_config on the command line with a fullyspecified name;
  • Location for API and API Configs. Defaults to global.

This must be specified.

API_CONFIG
ID of the api-config or fully qualified identifier for the api-config.

To set theapi-config attribute:

  • provide the argumentapi_config on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--api=API
API ID.

To set theapi attribute:

  • provide the argumentapi_config on the command line with a fullyspecified name;
  • provide the argument--api on the command line.
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 ismodified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. 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-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudalphaapi-gatewayapi-configsupdate--clear-labels

To remove all existing labels and create two new labels,foo andbaz:

gcloudalphaapi-gatewayapi-configsupdate--clear-labels--update-labelsfoo=bar,baz=qux
--remove-labels=[KEY,…]
List of label keys to remove. If a label does not exist it is silently ignored.If--update-labels is also specified then--update-labels is 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 help for details.

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:
gcloudapi-gatewayapi-configsupdate
gcloudbetaapi-gatewayapi-configsupdate

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-05-07 UTC.