Update Agent Config

This API updates an existing file encryption agent configuration, including its name, description, user, access token, mode, mount point protections, and object storage settings.

Endpoint Details

URL	/v1/config-agent/file-encryption-agents/id
Method	PUT
Authorization	Bearer Token

---

Request Headers

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

---

Request Path

To update an existing agent config, use the following request format:

/v1/config-agent/file-encryption-agents/36edcbba-3aad-4c4f-aa30-4b98ad555535

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the agent to update

---

Request Body

Use the following format to make a request:

JSON Request

{
  "agent_name": "dummy",
  "description": "add description agent dummy",
  "user_id": "0a937c60-0ed4-4d06-870a-2e284b54287d",
  "access_token_id": "f1a84190-e12c-43a2-b439-80461199e8c3",
  "mode": "AgentModeDirectory",
  "mount_point_protections": [
    {
      "policy_id": "553e852b-77d8-461c-9727-2ab342341dc7",
      "path_mount_point": "/data/secure",
      "bucket": ""
    }
  ],
  "object_storage": {
    "url": "",
    "access_key": "",
    "secret_key": "",
    "region_code": ""
  }
}

---

Body Parameters

Parameter	Type	Description
agent_name	String	Updated name of the agent
description	String	Optional description of the agent
user_id	UUID	Identifier of the user the agent is assigned to
access_token_id	UUID	Identifier of the access token used by the agent
mode	String	Operating mode of the agent
mount_point_protections	Array	List of mount points protected by the agent
policy_id	UUID	Identifier of the policy set applied to the mount point
path_mount_point	String	Path (or bucket) of the protected mount point
bucket	String	Bucket name of the protected mount point, used in object storage mode
object_storage	Object	Object storage configuration, required when the mode is object storage
url	String	Endpoint URL of the object storage service
access_key	String	Access key used to authenticate to the object storage
secret_key	String	Secret key used to authenticate to the object storage
region_code	String	Region code of the object storage service

---

Response

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

Response

{
    "data": {
        "id": "36edcbba-3aad-4c4f-aa30-4b98ad555535",
        "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
        "agent_name": "Dummy",
        "description": "add description agent dummy",
        "user_id": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "access_token_id": "f1a84190-e12c-43a2-b439-80461199e8c3",
        "mode": "AgentModeDirectory",
        "mount_point_protections": [
            {
                "policy_id": "553e852b-77d8-461c-9727-2ab342341dc7",
                "path_mount_point": "/data/secure"
            }
        ],
        "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "created_by_name": "Admin Aplikasi",
        "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "updated_by_name": "Admin Aplikasi",
        "created_at": 1785309679,
        "updated_at": 1785309756
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the agent
tenant_id	UUID	Identifier of the tenant that owns the agent
agent_name	String	Name of the agent
description	String	Description of the agent
user_id	UUID	Identifier of the user the agent is assigned to
access_token_id	UUID	Identifier of the access token used by the agent
mode	String	Operating mode of the agent
mount_point_protections	Array	List of mount points protected by the agent
policy_id	UUID	Identifier of the policy set applied to the mount point
path_mount_point	String	Path (or bucket) of the protected mount point
bucket	String	Bucket name of the protected mount point, used in object storage mode
object_storage	Object	Object storage configuration, present when the mode is object storage
created_by	UUID	Identifier of the user who created the agent
created_by_name	String	Display name of the user who created the agent
updated_by	UUID	Identifier of the user who last updated the agent
updated_by_name	String	Display name of the user who last updated the agent
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing agent.
• Supported mode values are:
  • AgentModeDirectory — protects files and directories on local storage.
  • AgentModeObjectStorage — protects objects in object storage. In this mode, the object_storage object (url, access_key, secret_key, region_code) must be filled in.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.