Update Key Version Status Encryption

This API updates the status of a specific key version of an encryption configuration identified by its unique ID and version number. It can be used to enable or disable a particular key version.

---

Endpoint Details

URL	/v1/crypto/items/id/versions/version/status
Method	PUT
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To update the status of a specific key version, use the following request format:

/v1/crypto/items/8471d88d-feda-4d0f-bb39-7f45d8976b94/versions/10/status

---

Path Parameters

Parameter	Type	Description
id	UUID	Unique identifier of the encryption configuration
version	Integer	Key version whose status is updated

---

Request Body

Use the following format to make a request:

JSON Request

{
  "enabled": false
}

---

Body Parameters

Parameter	Type	Description
enabled	Boolean	Indicates whether the key version is enabled or disabled

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "success": true
}

---

Field Descriptions

Field	Type	Description
success	Boolean	Indicates whether the key version status was successfully updated

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing encryption configuration.
• The version path parameter must reference an existing key version of the configuration.
• When enabled is set to false, the key version is disabled and can no longer be used for new operations.
• When enabled is set to true, the key version is re-enabled and can be used again.