Method: keyRings.get

Full name: projects.locations.keyRings.get

Returns metadata for a given KeyRing.

HTTP request

GET https://cloudkms.googleapis.com/v1/{name=projects/*/locations/*/keyRings/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the KeyRing to get.

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudkms.keyRings.get

Request body

The request body must be empty.

Response body

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

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