Method: cryptoKeyVersions.patch

Full name: projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch

Update a CryptoKeyVersion's metadata.

state may be changed between ENABLED and DISABLED using this method. See cryptoKeyVersions.destroy and cryptoKeyVersions.restore to move between other states.

HTTP request

PATCH https://cloudkms.googleapis.com/v1/{cryptoKeyVersion.name=projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
cryptoKeyVersion.name

string

Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required list of fields to be updated in this request.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of CryptoKeyVersion.

Response body

If successful, the response body contains an instance of CryptoKeyVersion.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud KMS Documentation