INinfisical
KMS Keys

Changed on

Update KMS key

patch/api/v1/kms/keys/{keyId}

Request

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

Path parameters

keyIdstring uuid required

The ID of the key to be updated.

Request body

namestring

The updated name of this key. Must be slug-friendly.

isDisabledboolean

The flag to enable or disable this key.

descriptionstring

The updated description of this key.

hasDeleteProtectionboolean

Enable or disable delete protection for this key.

Response

Default Response

Changes

  • 4243b6be5d38Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • 5dbb77aad0f5Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status