Method: projects.locations.kmsConfigs.verify

Verifies KMS config reachability.

HTTP request

POST https://netapp.googleapis.com/v1alpha1/{name=projects/*/locations/*/kmsConfigs/*}:verify

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the KMS Config to be verified.

Request body

The request body must be empty.

Response body

VerifyKmsConfigResponse contains the information if the config is correctly and error message.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "healthy": boolean,
  "healthError": string,
  "instructions": string
}
Fields
healthy

boolean

Output only. If the customer key configured correctly to the encrypt volume.
healthError

string

Output only. Error message if config is not healthy.
instructions

string

Output only. Instructions for the customers to provide the access to the encryption key.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • netapp.kmsConfigs.verify

For more information, see the IAM documentation.