Update Encryption

This API updates the configuration of an existing encryption item, including its name, description, assigned users, group assignment, automatic rotation settings, and export policy.

---

Endpoint Details

URL	/v1/crypto/items/id
Method	PUT
Authorization	Bearer Token

---

Request Headers

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

---

Request Path

To update an existing encryption configuration, use the following request format:

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

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the encryption configuration to update

---

Request Body

Use the following format to make a request:

JSON Request

{
  "name": "dummy 1",
  "description": "",
  "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
  "assigned_user_ids": [
    "0a937c60-0ed4-4d06-870a-2e284b54287d"
  ],
  "auto_rotate": false,
  "rotation_interval": "",
  "exportable": true
}

---

Body Parameters

Parameter	Type	Description
name	String	Updated name of the encryption configuration
description	String	Optional description of the encryption configuration
group_id	UUID	Identifier of the group associated with the encryption configuration
assigned_user_ids	Array	List of user IDs authorized to access the encryption configuration
auto_rotate	Boolean	Enables or disables automatic key rotation
rotation_interval	String	Automatic rotation interval when auto_rotate is enabled
exportable	Boolean	Indicates whether the encryption key can be exported

---

Response

Here is an example response when the data is successfully updated:

Response

{
    "item": {
        "id": "8471d88d-feda-4d0f-bb39-7f45d8976b94",
        "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
        "name": "Dummy 1",
        "algorithm": "RSA1024",
        "lock_ring_id": "crypto/8471d88d-feda-4d0f-bb39-7f45d8976b94",
        "current_version": 1,
        "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
        "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "created_at": 1782274352,
        "updated_at": 1783310406,
        "assigned_user_ids": [
            "0a937c60-0ed4-4d06-870a-2e284b54287d"
        ],
        "exportable": true
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the encryption configuration
tenant_id	UUID	Identifier of the tenant that owns the encryption configuration
name	String	Name of the encryption configuration
algorithm	String	Encryption algorithm used by the configuration
lock_ring_id	String	Internal identifier associated with the encryption configuration
current_version	Integer	Current version of the encryption configuration
group_id	UUID	Identifier of the associated group
created_by	UUID	Identifier of the user who created the configuration
updated_by	UUID	Identifier of the user who last updated the configuration
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
assigned_user_ids	Array	List of user IDs assigned to the encryption configuration
exportable	Boolean	Indicates whether the encryption key can be exported

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing encryption configuration.
• Only the configuration settings can be updated. The encryption algorithm and existing key material are not modified by this endpoint.
• If auto_rotate is set to true, specify a valid value for rotation_interval.
• Supported rotation interval units are:
  • m = Minute.
  • h = Hour.
  • d = Day.
  • w = Week.
  • M = Month.
  • y = Year.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.