Skip to main content

Create Agent Config

This API creates a new file encryption agent configuration, binding a user, access token, mode, and the policies applied to protected mount points.

Endpoint Details

URL/v1/config-agent/file-encryption-agents
MethodPOST
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Body

Use the following format to make a request:

JSON Request
{
"agent_name": "dummy",
"description": "",
"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": ""
}
}

Parameters

ParameterTypeDescription
agent_nameStringName of the agent
descriptionStringOptional description of the agent
user_idUUIDIdentifier of the user the agent is assigned to
access_token_idUUIDIdentifier of the access token used by the agent
modeStringOperating mode of the agent
mount_point_protectionsArrayList of mount points protected by the agent
policy_idUUIDIdentifier of the policy set applied to the mount point
path_mount_pointStringPath (or bucket) of the protected mount point
bucketStringBucket name of the protected mount point, used in object storage mode
object_storageObjectObject storage configuration, required when the mode is object storage
urlStringEndpoint URL of the object storage service
access_keyStringAccess key used to authenticate to the object storage
secret_keyStringSecret key used to authenticate to the object storage
region_codeStringRegion code of the object storage service

Response

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

Response
{
"data": {
"id": "36edcbba-3aad-4c4f-aa30-4b98ad555535",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"agent_name": "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"
}
],
"object_storage": {},
"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": 1785309679
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the agent
tenant_idUUIDIdentifier of the tenant that owns the agent
agent_nameStringName of the agent
descriptionStringDescription of the agent
user_idUUIDIdentifier of the user the agent is assigned to
access_token_idUUIDIdentifier of the access token used by the agent
modeStringOperating mode of the agent
mount_point_protectionsArrayList of mount points protected by the agent
policy_idUUIDIdentifier of the policy set applied to the mount point
path_mount_pointStringPath (or bucket) of the protected mount point
bucketStringBucket name of the protected mount point, used in object storage mode
object_storageObjectObject storage configuration, present when the mode is object storage
created_byUUIDIdentifier of the user who created the agent
created_by_nameStringDisplay name of the user who created the agent
updated_byUUIDIdentifier of the user who last updated the agent
updated_by_nameStringDisplay name of the user who last updated the agent
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • 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.
  • When the mode is AgentModeDirectory, the object_storage object is not used and is returned as an empty object {}.
  • Each entry in mount_point_protections binds a policy set to a protected path or bucket.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.