- NAME
-
- gcloud alpha dns outbound-endpoints update - updates an existing Cloud DNS outbound endpoint
- SYNOPSIS
-
-
gcloud alpha dns outbound-endpoints update(OUTBOUND_ENDPOINT:--location=LOCATION) [--async] [--description=DESCRIPTION] [--endpoint-mode=ENDPOINT_MODE] [--update-labels=[KEY=VALUE,…]] [--clear-labels|--remove-labels=[KEY,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)This command updates the description or labels of an existing Cloud DNS outbound endpoint. - EXAMPLES
-
To update the description of an outbound endpoint
my-endpointinus-east1, run:gcloud alpha dns outbound-endpoints update my-endpoint --location=us-east1 --description="Updated description" - POSITIONAL ARGUMENTS
-
-
Outbound endpoint resource - The outbound endpoint to update. The arguments in
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 other ways.
To set the
projectattribute:-
provide the argument
outbound_endpointon the command line with a fully specified name; -
set the property
core/project.
This must be specified.
OUTBOUND_ENDPOINT-
ID of the outbound_endpoint or fully qualified identifier for the
outbound_endpoint.
To set the
outbound-endpointattribute:-
provide the argument
outbound_endpointon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The Cloud location for the outbound_endpoint.
To set the
locationattribute:-
provide the argument
outbound_endpointon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Outbound endpoint resource - The outbound endpoint to update. The arguments in
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 other ways.
- FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--description=DESCRIPTION- A description of the outbound endpoint.
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
--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 alpha dns outbound-endpoints update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud alpha dns outbound-endpoints 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. - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred. - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. This variant is also available:
gcloud beta dns outbound-endpoints update
gcloud alpha dns outbound-endpoints 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-10-13 UTC.