# REST Resource: projects.locations.kmsConfigs

- [Resource: KmsConfig](https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs#KmsConfig)
  - [JSON representation](https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs#KmsConfig.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs#State)
- [Methods](https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs#METHODS_SUMMARY)

## Resource: KmsConfig

KmsConfig is the customer-managed encryption key(CMEK) configuration.

| JSON representation |
|---|
| ``` { "name": string, "cryptoKeyName": string, "state": enum (`https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs#State`), "stateDetails": string, "createTime": string, "description": string, "labels": { string: string, ... }, "instructions": string, "serviceAccount": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kmsConfig}` |
| `cryptoKeyName` | `string` Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` |
| `state` | ``enum (`https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs#State`)`` Output only. State of the KmsConfig. |
| `stateDetails` | `string` Output only. State details of the KmsConfig. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Create time of the KmsConfig. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `description` | `string` Description of the KmsConfig. |
| `labels` | `map (key: string, value: string)` Labels as key value pairs An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `instructions` | `string` Output only. Instructions to provide the access to the customer provided encryption key. |
| `serviceAccount` | `string` Output only. The Service account which will have access to the customer provided encryption key. |

## State

The KmsConfig States

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified KmsConfig State |
| `READY` | KmsConfig State is Ready |
| `CREATING` | KmsConfig State is Creating |
| `DELETING` | KmsConfig State is Deleting |
| `UPDATING` | KmsConfig State is Updating |
| `IN_USE` | KmsConfig State is In Use. |
| `ERROR` | KmsConfig State is Error |
| `KEY_CHECK_PENDING` | KmsConfig State is Pending to verify crypto key access. |
| `KEY_NOT_REACHABLE` | KmsConfig State is Not accessbile by the SDE service account to the crypto key. |
| `DISABLING` | KmsConfig State is Disabling. |
| `DISABLED` | KmsConfig State is Disabled. |
| `MIGRATING` | KmsConfig State is Migrating. The existing volumes are migrating from SMEK to CMEK. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/create` | Creates a new KMS config. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/delete` | Warning! |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/encrypt` | Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/get` | Returns the description of the specified KMS config by kms_config_id. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/list` | Returns descriptions of all KMS configs owned by the caller. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/patch` | Updates the Kms config properties with the full spec |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.kmsConfigs/verify` | Verifies KMS config reachability. |