KMS

KakaoCloud Key Management Service (KMS) creates and securely manages encryption keys used for data encryption and digital signatures.

Base URL

The KMS API base URL is as follows.

https://key-management-service.kr-central-2.kakaocloud.com

APIs by resource

Select an API for key resources such as keys, key versions, and public keys to view its request details and response format.

KMS

Manages KMS service activation and status.

API	Method	Path
Activate KMS service	POST	/api/v1/activation
Get KMS service status	GET	/api/v1/activation

Key versions

Manages key versions and destruction schedules.

API	Method	Path
Bulk cancel scheduled key version destruction	PATCH	/api/v1/keys/{key_id}/versions/cancel-schedule-destroy
Bulk schedule key version destruction	PATCH	/api/v1/keys/{key_id}/versions/schedule-destroy
Cancel scheduled key version destruction	PATCH	/api/v1/keys/{key_id}/versions/{version}/cancel-schedule-destroy
Create key version	POST	/api/v1/keys/{key_id}/versions
Deactivate key version	PATCH	/api/v1/keys/{key_id}/versions/{version}/deactivate
List key versions	GET	/api/v1/keys/{key_id}/versions
Schedule key version destruction	PATCH	/api/v1/keys/{key_id}/versions/{version}/schedule-destroy

Keys

Manages keys, access control, and rotation.

API	Method	Path
Add user key access targets	POST	/api/v1/keys/{key_id}/access-control/targets
Bulk delete user keys	POST	/api/v1/keys/deletions
Create user key	POST	/api/v1/keys
Delete user key	DELETE	/api/v1/keys/{key_id}
Get key	GET	/api/v1/keys/{key_id}
Get key by name	GET	/api/v1/keys/name/{key_name}
Get public key	GET	/api/v1/keys/{key_id}/public-key
List key algorithms	GET	/api/v1/algorithms
List service keys	GET	/api/v1/service-keys
List symmetric keys	GET	/api/v1/symmetric-keys
List user key access targets	GET	/api/v1/keys/{key_id}/access-control/targets
List user keys	GET	/api/v1/keys
Remove user key access targets	POST	/api/v1/keys/{key_id}/access-control/targets/deletions
Update user key access control	PUT	/api/v1/keys/{key_id}/access-control
Update user key rotation	PATCH	/api/v1/keys/{key_id}/rotation

Public keys

Provides cryptographic operations.

API	Method	Path
Create data key	POST	/api/v1/keys/{key_id}/data-key
Decrypt data	POST	/api/v1/keys/{key_id}/decrypt
Encrypt data	POST	/api/v1/keys/{key_id}/encrypt
Generate HMAC	POST	/api/v1/keys/{key_id}/hmac
Sign data	POST	/api/v1/keys/{key_id}/sign
Verify HMAC	POST	/api/v1/keys/{key_id}/hmac/verify
Verify signature	POST	/api/v1/keys/{key_id}/sign/verify