KMS Keys

Changed on

Create KMS key

post/api/v1/kms/keys

Request

  • Base URL
    https://us.infisical.com
  • URL
    https://us.infisical.com/api/v1/kms/keys
  • Auth
    none declared

Request body

projectIdstring required

The ID of the project to create the key in.

namestring required

The name of the key to be created. Must be slug-friendly.

descriptionstring

An optional description of the key.

keyUsage'encrypt-decrypt' | 'sign-verify' | 'generate-verify-mac'

The type of key to be created, either encrypt-decrypt or sign-verify, based on your intended use for the key.

algorithm'aes-256-gcm' | 'aes-128-gcm' | 'RSA_4096' | 'ECC_NIST_P256' | 'ECC_NIST_P384' | 'ECC_NIST_P521' | 'ED25519' | 'ML_DSA_44' | 'ML_DSA_65' | 'ML_DSA_87' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512'

The cryptographic algorithm of the key (e.g. aes-256-gcm, RSA_4096, HMAC_SHA_256).

isExportableboolean

Whether the raw key material can be exported after creation. When set to false, the key can never be exported regardless of permissions. This cannot be changed after creation.

hasDeleteProtectionboolean

Prevents deletion of the key when enabled.

Response

Default Response

Changes

  • 514021b0a05eRevision changes
    • info

      added the new ED25519 enum value to the request property

  • 4243b6be5d38Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status