gcloud parametermanager parameters update

NAME
gcloud parametermanager parameters update - updates the metadata of an Parameter Manager parameter resource
SYNOPSIS
gcloud parametermanager parameters updatePARAMETER[--location=LOCATION][--parameter-format=PARAMETER_FORMAT][--request-id=REQUEST_ID][--key-ring=KEY_RING--clear-kms-key    |--kms-key=KMS_KEY][--labels=[LABELS,…]    |--update-labels=[UPDATE_LABELS,…]--clear-labels    |--remove-labels=REMOVE_LABELS][GCLOUD_WIDE_FLAG]
DESCRIPTION
Update the metadata of a parameter (e.g. labels). This command will return anerror if you specify a parameter that does not exist.
EXAMPLES
To update a parametermy-parameter in locationglobalrun:
gcloudparametermanagerparametersupdatemy-parameter--location=global
POSITIONAL ARGUMENTS
Parameter resource - Identifier. [Output only] The resource name of theParameter in the formatprojects/*/locations/*/parameters/*. Thisrepresents a Cloud resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.

To set theproject attribute:

  • provide the argumentparameter 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 argumentparameter on the command line with a fullyspecified name;
  • provide the argument--location on the command line.

This must be specified.

PARAMETER
ID of the parameter or fully qualified identifier for the parameter.

To set theparameter attribute:

  • provide the argumentparameter on the command line.
FLAGS
--location=LOCATION
For resources [parameter, kms-key], provides fallback value for resourcelocation attribute. When the resource's full URI path is not provided, locationwill fallback to this flag value.
--parameter-format=PARAMETER_FORMAT
Specifies the format of a Parameter.PARAMETER_FORMATmust be one of:
json
JSON format.
unformatted
Unformatted.
yaml
YAML format.
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request ID so thatif you must retry your request, the server will know to ignore the request if ithas already been completed. The server will guarantee that for at least 60minutes since the first request.

For example, consider a situation where you make an initial request and therequest times out. If you make the request again with the same request ID, theserver can check if original operation with the same request ID was received,and if so, will ignore the second request. This prevents clients fromaccidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is notsupported (00000000-0000-0000-0000-000000000000).

Arguments for the kms key.
All arguments needed to update kms_key.
--key-ring=KEY_RING
The keyRing id of the cryptoKey resource.

To set thekey-ring attribute:

  • provide the argument--current on the command line with a fullyspecified name;
  • provide the argument--key-ring on the command line.
Update kms_key.

At most one of these can be specified:

--clear-kms-key
Clear kms_key value and set to null.
CryptoKey resource - Set kms_key to new value.

Customer managed encryption key (CMEK) to use for encrypting the ParameterVersions. If not set, the default Google-managed encryption key will be used.Cloud KMS CryptoKeys must reside in the same location as the Parameter. Theexpected format isprojects/*/locations/*/keyRings/*/cryptoKeys/*.This represents a Cloud resource. (NOTE) Some attributes are not given argumentsin this group but can be set in other ways.

To set theproject attribute:

  • provide the argument--kms-key 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 argument--kms-key on the command line with a fullyspecified name;
  • provide the argument--location on the command line.

To set thekey-ring attribute:

  • provide the argument--kms-key on the command line with a fullyspecified name;
  • provide the argument--key-ring on the command line.
--kms-key=KMS_KEY
ID of the cryptoKey or fully qualified identifier for the cryptoKey.

To set thecrypto-key attribute:

  • provide the argument--kms-key on the command line.
Update labels.

At most one of these can be specified:

--labels=[LABELS,…]
Set labels to new value. Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers.
VALUE
Values must contain only hyphens (-), underscores (_),lowercase characters, and numbers.
Shorthand Example:
--labels=string=string

JSON Example:

--labels='{"string": "string"}'

File Example:

--labels=path_to_file.(yaml|json)
Or at least one of these can be specified:
--update-labels=[UPDATE_LABELS,…]
Update labels value or add key value pair. Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers.
VALUE
Values must contain only hyphens (-), underscores (_),lowercase characters, and numbers.
Shorthand Example:
--update-labels=string=string

JSON Example:

--update-labels='{"string": "string"}'

File Example:

--update-labels=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-labels
Clear labels value and set to empty map.
--remove-labels=REMOVE_LABELS
Remove existing value from map labels. Setsremove_labels value.Shorthand Example:
--remove-labels=string,string

JSON Example:

--remove-labels=["string"]

File Example:

--remove-labels=path_to_file.(yaml|json)
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 theparametermanager/v1 API. The fulldocumentation for this API can be found at:https://cloud.google.com/secret-manager/parameter-manager/docs/overview

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 2026-01-21 UTC.