PATCH
/
api
/
v1
/
kms
/
keys
/
{keyId}
curl --request PATCH \
  --url https://us.infisical.com/api/v1/kms/keys/{keyId} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "isDisabled": true,
  "description": "<string>"
}'
{
  "key": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "isDisabled": false,
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "projectId": "<string>",
    "version": 1,
    "encryptionAlgorithm": "<string>"
  }
}

Path Parameters

keyId
string
required

The ID of the key to be updated.

Body

application/json
name
string

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

Required string length: 1 - 32
isDisabled
boolean

The flag to enable or disable this key.

description
string

The updated description of this key.

Maximum length: 500

Response

200
application/json
Default Response
key
object
required