dli

19 endpoints

GET/rest/dli/exports

Return the list of all exports for all users

Returns a paginated list of all data exports across all users, including each export's status, type, date range, and download URL. Requires admin privileges.

Parameters

Query Parameters

user_id

Optional

string

Unique identifier of user

user_id:in

Optional

string

Unique identifier of user. Search for results that match any of the specified values for this parameter.

status

Optional

string

Status of the generated report

status:contains

Optional

string

Status of the generated report. Search for results that contain the specified characters in this parameter.

offset

Optional

integer

Offset

limit

Optional

integer

Limit

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of exports retrieved successfully.

data

Export[]

string

Export task unique identifier

startDate

string

Export start date

endDate

string

Export end date

status

string

Current status of the export. Accepted values: inprocess, error, completed, nodata

downloadURL

string

URL for downloading the exported data

type

string

Export type. Accepted values: activities, files, emails

userId

Required

string

Unique identifier of the user

generatedDate

string

Date when the report was generated

fileName

string

Name of the generated export report file available for download

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/exports" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

url = "https://{instance}.kiteworks.com/rest/dli/exports"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": "exp-guid-001", "status": "completed", "type": "files", "startDate": "2024-01-01", "endDate": "2024-01-31", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "generatedDate": "2024-02-01T08:00:00Z", "fileName": "export_files_jan2024.zip", "downloadURL": "https://example.com/exports/exp-guid-001" } ], "metadata": { "total": 1, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

// Error - No Body

POST/rest/dli/exports/users/{id}

Start generating export for the specified user

Initiates one or more data export jobs for the specified user based on the requested report types and date range. Returns the newly created export record(s) in a pending state. Requires admin privileges.

Parameters

Path Parameters

Required

string

ID of the user

Query Parameters

returnEntity

Optional

boolean

If set to true, returns information about the newly created entity.

mode

Optional

string

Determines the detail level of the response body.

Request Body

startDate

Required

string

Export start date

endDate

Required

string

Export end date

types

Required

string[]

Export type. Accepted values: activities, files, emails

addLinks

boolean

Indicates whether HATEOAS links should be included in the response

Responses

Export job(s) created successfully.

data

Export[]

string

Export task unique identifier

startDate

string

Export start date

endDate

string

Export end date

status

string

Current status of the export. Accepted values: inprocess, error, completed, nodata

downloadURL

string

URL for downloading the exported data

type

string

Export type. Accepted values: activities, files, emails

userId

Required

string

Unique identifier of the user

generatedDate

string

Date when the report was generated

fileName

string

Name of the generated export report file available for download

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Unprocessable Content

Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_DATE_NOT_BEFORE, ERR_INPUT_REQUIRED, ERR_INPUT_DATE_NOT_AFTER, ERR_INPUT_NOT_ARRAY, ERR_INPUT_NOT_IN_LIST

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X POST \
  "https://{instance}.kiteworks.com/rest/dli/exports/users/:id" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "startDate": "2024-01-15",
         "endDate": "2024-01-15",
         "types": [
         "string"
       ],
         "addLinks": true
       }'

Python

import requests

id = "VALUE"  # ID of the user

url = f"https://{{instance}}.kiteworks.com/rest/dli/exports/users/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "startDate": "2024-01-15",
  "endDate": "2024-01-15",
  "types": [
  "string"
],
  "addLinks": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

{ "data": [ { "id": "exp-guid-002", "status": "pending", "type": "activities", "startDate": "2024-03-01", "endDate": "2024-03-31", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "generatedDate": null, "fileName": null, "downloadURL": null } ], "metadata": { "total": 1, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

{ "errors": { "code": "ERR_INPUT_REQUIRED", "message": "Field is required" } }

// Error - No Body

GET/rest/dli/exports/{id}

Return information of an export such as status, download url, user ID, etc.

Returns the details of a specific export job, including its status, type, date range, the user it belongs to, and the download URL when the export is complete. Requires admin privileges.

Parameters

Path Parameters

Required

integer

ID of the export

Responses

Export details retrieved successfully.

data

Export[]

string

Export task unique identifier

startDate

string

Export start date

endDate

string

Export end date

status

string

Current status of the export. Accepted values: inprocess, error, completed, nodata

downloadURL

string

URL for downloading the exported data

type

string

Export type. Accepted values: activities, files, emails

userId

Required

string

Unique identifier of the user

generatedDate

string

Date when the report was generated

fileName

string

Name of the generated export report file available for download

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/exports/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the export

url = f"https://{{instance}}.kiteworks.com/rest/dli/exports/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "id": "exp-guid-001", "status": "completed", "type": "files", "startDate": "2024-01-01", "endDate": "2024-01-31", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "generatedDate": "2024-02-01T08:00:00Z", "fileName": "export_files_jan2024.zip", "downloadURL": "https://example.com/exports/exp-guid-001" }

{ "id": "exp-guid-002", "status": "pending", "type": "activities", "startDate": "2024-03-01", "endDate": "2024-03-31", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "generatedDate": null, "fileName": null, "downloadURL": null }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

DELETE/rest/dli/exports/{id}

Delete the specified export.

Permanently deletes the specified export record and its associated data. Requires admin privileges.

Parameters

Path Parameters

Required

integer

ID of the export

Responses

Export deleted successfully.

Empty response body.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X DELETE \
  "https://{instance}.kiteworks.com/rest/dli/exports/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the export

url = f"https://{{instance}}.kiteworks.com/rest/dli/exports/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())

Responses

// Request successful - No Body

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/exports/{id}/content

Download the generated export.

Downloads the generated export file as a binary stream. The export must be in a completed state before it can be downloaded. Requires admin privileges.

Parameters

Path Parameters

Required

integer

ID of the export

Responses

Export file returned as a binary stream.

Empty response body.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/exports/:id/content" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the export

url = f"https://{{instance}}.kiteworks.com/rest/dli/exports/{id}/content"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

// Request successful - No Body

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{fileId}/users/{userId}/activities

Return the list of Activities for this file

Returns all activities performed by the specified user on the specified file. Each activity includes the affected object, a human-readable message, the acting user, and whether the action was successful. Requires admin privileges.

Parameters

Path Parameters

fileId

Required

string

ID of the file

userId

Required

string

The unique identifier of the user.

Query Parameters

noDayBack

Optional

integer

Number of days back to search

startDate

Optional

string

Start date

endDate

Optional

string

End date

filter

Optional

string

Filter activities by scope. Accepted values: all, my.

Optional

string

Search by mail body, subject and sender/recipients

type

Optional

string

Filter activities by type. Accepted values: all, folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint.

transactionId

Optional

string

Transaction ID associated with the activities

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of file activities for the user retrieved successfully.

data

ActivityAdmin[]

created

string

Activity creation date

data

string[]

Contains information about affected entities

permissions

string[]

List of actions allowed for the user on the object in the activity

event

Required

string

Activity event name

Required

integer

Unique Activity identifier

message

Required

string

User-friendly message

type

Required

string

Activity type. Accepted values: folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint, admin

user

Required

string

User associated with the activity

successful

integer

Indicates whether the activity was successful

object

string[]

Contains information about the affected file or folder

directUser

string[]

Direct user associated with the activity

inDirectUsers

string[]

Indirect users associated with the activity

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:fileId/users/:userId/activities" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

fileId = "VALUE"  # ID of the file
userId = "VALUE"  # The unique identifier of the user.

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{fileId}/users/{userId}/activities"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "object": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "contract.pdf", "type": "file" }, "message": "User downloaded file contract.pdf", "directUser": { "id": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "name": "Alice Smith", "email": "alice@example.com" }, "successful": 1 } ] }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}

Retrieve information about the file specified.

Returns metadata for the specified file, including its name, size, MIME type, content fingerprint, creation and modification dates, deletion status, and lock state.

Parameters

Path Parameters

Required

string

ID of the file

Query Parameters

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

File metadata retrieved successfully.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

Unique identifier (UUID) of the associated object (file or folder).

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

role

object

Role details assigned to the member.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

group

object

Group details if the member belongs to a group.

integer

LDAP Group ID

name

string

LDAP Group name

string

LDAP Group domain name

string

LDAP Group email

description

string

LDAP Group description

sharedBy

object

Details of the user who shared the file or folder.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

The algorithm used to generate the fingerprint (e.g., sha3-256, md5).

hash

string

The resulting hash value representing the fingerprint of the file or object.

clientCreated

string

The date and time when the file was created on the client side.

clientModified

string

The date and time when the file was last modified on the client side.

overriddenExpire

boolean

Indicates whether the expiration date for the file has been overridden.

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

Unique identifier (UUID) of the associated object (file or folder).

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

role

object

Role details assigned to the member.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

group

object

Group details if the member belongs to a group.

integer

LDAP Group ID

name

string

LDAP Group name

string

LDAP Group domain name

string

LDAP Group email

description

string

LDAP Group description

sharedBy

object

Details of the user who shared the file or folder.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

The ID of the original file if this one is a copy.

avStatus

string

Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.

dlpStatus

string

Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.

adminQuarantineStatus

string

Indicates the file version's availability status based on the administrator's quarantine status.

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

Unique identifier (UUID) for the user who pushed the object.

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pathIds

string

A list of IDs representing the path of the file within the folder hierarchy.

wopiapp

object

WOPI-related information for the file when used in a mobile app.

wopiSrc

string

The WOPI (Web Application Open Platform Interface) source URL for the mobile application.

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

URI scheme used by the mobile application to handle the file.

schemeSupport

string

Indicates the level of support the mobile app has for the URI scheme.

pushed

boolean

Indicates if the file has been pushed to a mobile app.

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the file

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "contract.pdf", "size": 204800, "mime": "application/pdf", "fingerprint": "d41d8cd98f00b204e9800998ecf8427e", "created": "2024-01-15T10:30:00Z", "modified": "2024-03-20T14:45:00Z", "deleted": false, "locked": 0, "parentId": "f0e1d2c3-b4a5-6789-0fed-cba987654321" }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}/content

Read file content

Downloads the binary content of the specified file. Supports partial downloads via the Range header.

Parameters

Path Parameters

Required

string

ID of the file

Header Parameters

Range

Optional

string

Range of bytes to download. e.g. bytes=0-1024

Responses

File content returned as a binary stream.

Empty response body.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id/content" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the file

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}/content"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

// Request successful - No Body

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}/path

Get file path

Returns the full ancestor path of the specified file as an ordered list of folder nodes, from the workspace root down to the file's parent folder.

Parameters

Path Parameters

Required

string

ID of the file

Query Parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

File path retrieved successfully.

data

FolderTreeItem[]

Ordered list of folder nodes representing the path from the workspace root to the file's parent folder.

links

HateoasLink[]

Optional HATEOAS links. Present only when the request includes link options.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id/path" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the file

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}/path"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": "root-folder-guid", "name": "Workspace" }, { "id": "sub-folder-guid", "name": "Projects" }, { "id": "parent-folder-guid", "name": "Q1 Reports" } ], "links": [ { "rel": "self", "href": "https://example.com/api/rest/1/dli/files/a1b2c3d4/path" } ] }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}/preview

Retrieve information about the file preview.

Returns preview access links and processing status for the specified file.

Parameters

Path Parameters

Required

string

ID of the file

Responses

Preview metadata retrieved successfully.

link

string

Preview link for the file

pdf

string

PDF file for the preview

viewUrl

string

URL for viewing the preview

status

string

Preview processing status. Accepted values: processing, preview, failed

type

string

Format of the generated preview, such as image or PDF

metadata

string

Additional metadata about the preview, such as dimensions or page count

mime

string

MIME type of the preview file

native

boolean

Indicates whether the preview is a native render

watermark

string

Watermark applied to the preview

tdfOriginalExtension

string

Original file extension for TDF files

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id/preview" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the file

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}/preview"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "link": "https://example.com/preview/abc123/dli/1", "pdf": "https://example.com/preview/abc123/pdf/dli/1", "viewUrl": "https://example.com/preview/abc123/view/dli/1", "status": "Preview", "watermark": "CONFIDENTIAL", "tdfOriginalExtension": null }

{ "link": "https://example.com/preview/abc123/dli/1", "pdf": "https://example.com/preview/abc123/pdf/dli/1", "viewUrl": "https://example.com/preview/abc123/view/dli/1", "status": "Processing", "watermark": null, "tdfOriginalExtension": null }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}/versions

List versions

Returns a paginated list of all versions for the specified file. Each version includes its name, size, MIME type, creation date, creator, and content fingerprint.

Parameters

Path Parameters

Required

string

Object id of file to retrieve versions for

Query Parameters

created

Optional

integer

File Version creation date

created:gt

Optional

integer

File Version creation date. Search for results where this parameter value is greater than the specified value.

created:gte

Optional

integer

File Version creation date. Search for results where this parameter value is greater than or equal to the specified value.

created:lt

Optional

integer

File Version creation date. Search for results where this parameter value is less than the specified value.

created:lte

Optional

integer

File Version creation date. Search for results where this parameter value is less than or equal to the specified value.

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

locate_id

Optional

integer

If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of file versions retrieved successfully.

data

Version[]

Required

string

The unique identifier of the file version.

versionNumber

Required

integer

The version number of the file.

deleted

boolean

Indicates whether this version of the file has been deleted.

created

string

The creation date of this file version.

userId

Required

string

The unique identifier of the user who created this file version.

size

integer

The size of the file content in bytes.

fingerprint

string

A unique hash identifying the file.

fingerprintAlgo

string

The algorithm used to generate the fingerprint (e.g., sha3-256, md5).

backend

string

The backend system associated with the file version.

mime

string

The MIME type of the file version.

name

Required

string

The name of the file version.

creator

UserBasicInfo

The user who created the file version. (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

objectId

Required

string

The object ID (UUID) for the file version.

clientCreated

string

The date and time the file version was created on the client side.

clientModified

string

The date and time the file version was last modified on the client side.

avStatus

string

Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.

dlpStatus

string

Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.

adminQuarantineStatus

string

Indicates the file version\'s availability status based on the administrator\'s quarantine status.

storageAvailable

boolean

Indicates whether the file is accessible on any storage volume.

fingerprints

string[]

A list of fingerprints associated with the file version.

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id/versions" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # Object id of file to retrieve versions for

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}/versions"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": "v1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "report_v2.pdf", "versionNumber": 2, "size": 102400, "mime": "application/pdf", "fingerprint": "abc123def456", "created": "2024-03-20T14:45:00Z", "deleted": false, "objectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ], "metadata": { "total": 1, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}/versions/{version_id}

Allow DLI admin to get specified version

Returns the metadata for a specific version of a file, including its name, size, MIME type, creation date, creator, and content fingerprint.

Parameters

Path Parameters

Required

string

Object id of file to retrieve versions for

version_id

Required

string

version ID

Responses

Version metadata retrieved successfully.

Required

string

The unique identifier of the file version.

versionNumber

Required

integer

The version number of the file.

deleted

boolean

Indicates whether this version of the file has been deleted.

created

string

The creation date of this file version.

userId

Required

string

The unique identifier of the user who created this file version.

size

integer

The size of the file content in bytes.

fingerprint

string

A unique hash identifying the file.

fingerprintAlgo

string

The algorithm used to generate the fingerprint (e.g., sha3-256, md5).

backend

string

The backend system associated with the file version.

mime

string

The MIME type of the file version.

name

Required

string

The name of the file version.

creator

UserBasicInfo

The user who created the file version. (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

objectId

Required

string

The object ID (UUID) for the file version.

clientCreated

string

The date and time the file version was created on the client side.

clientModified

string

The date and time the file version was last modified on the client side.

avStatus

string

Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.

dlpStatus

string

Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.

adminQuarantineStatus

string

Indicates the file version\'s availability status based on the administrator\'s quarantine status.

storageAvailable

boolean

Indicates whether the file is accessible on any storage volume.

fingerprints

string[]

A list of fingerprints associated with the file version.

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

links

string[]

HATEOAS links associated with the entity

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id/versions/:version_id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # Object id of file to retrieve versions for
version_id = "VALUE"  # version ID

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}/versions/{version_id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "id": "v1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "report_v2.pdf", "versionNumber": 2, "size": 102400, "mime": "application/pdf", "fingerprint": "abc123def456", "created": "2024-03-20T14:45:00Z", "deleted": false, "objectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/files/{id}/versions/{version_id}/content

Download specified version

Downloads the binary content of the specified file version. Supports partial downloads via the Range header.

Parameters

Path Parameters

Required

string

ID of the file

version_id

Required

string

version ID for which to retrieve content

Header Parameters

Range

Optional

string

Range of bytes to download. e.g. bytes=0-1024

Responses

Version content returned as a binary stream.

Empty response body.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/files/:id/versions/:version_id/content" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the file
version_id = "VALUE"  # version ID for which to retrieve content

url = f"https://{{instance}}.kiteworks.com/rest/dli/files/{id}/versions/{version_id}/content"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

// Request successful - No Body

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/folders/{folderId}/users/{userId}/activities

Return the list of activities for this folder of the specified user

Returns all activities performed by the specified user on the specified folder. Each activity includes the affected object, a human-readable message, the acting user, and whether the action was successful. Requires admin privileges.

Parameters

Path Parameters

folderId

Required

string

The unique identifier of the folder.

userId

Required

string

The unique identifier of the user.

Query Parameters

noDayBack

Optional

integer

Number of days back to search

startDate

Optional

string

Start date

endDate

Optional

string

End date

filter

Optional

string

Filter activities by scope. Accepted values: all, my.

Optional

string

Search by mail body, subject and sender/recipients

type

Optional

string

Filter activities by type. Accepted values: all, folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint.

transactionId

Optional

string

Transaction ID associated with the activities

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of folder activities for the user retrieved successfully.

data

ActivityAdmin[]

created

string

Activity creation date

data

string[]

Contains information about affected entities

permissions

string[]

List of actions allowed for the user on the object in the activity

event

Required

string

Activity event name

Required

integer

Unique Activity identifier

message

Required

string

User-friendly message

type

Required

string

Activity type. Accepted values: folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint, admin

user

Required

string

User associated with the activity

successful

integer

Indicates whether the activity was successful

object

string[]

Contains information about the affected file or folder

directUser

string[]

Direct user associated with the activity

inDirectUsers

string[]

Indirect users associated with the activity

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/folders/:folderId/users/:userId/activities" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

folderId = "VALUE"  # The unique identifier of the folder.
userId = "VALUE"  # The unique identifier of the user.

url = f"https://{{instance}}.kiteworks.com/rest/dli/folders/{folderId}/users/{userId}/activities"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "object": { "id": "f0e1d2c3-b4a5-6789-0fed-cba987654321", "name": "Q1 Reports", "type": "folder" }, "message": "User uploaded file to Q1 Reports", "directUser": { "id": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "name": "Alice Smith", "email": "alice@example.com" }, "successful": 1 } ] }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/folders/{id}

Retrieve folder information.

Returns metadata for the specified folder, including its name, creation date, deletion status, and permalink.

Parameters

Path Parameters

Required

string

The unique identifier of the folder.

Query Parameters

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

Folder metadata retrieved successfully.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

Unique identifier (UUID) of the associated object (file or folder).

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

role

object

Role details assigned to the member.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

group

object

Group details if the member belongs to a group.

integer

LDAP Group ID

name

string

LDAP Group name

string

LDAP Group domain name

string

LDAP Group email

description

string

LDAP Group description

sharedBy

object

Details of the user who shared the file or folder.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/folders/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # The unique identifier of the folder.

url = f"https://{{instance}}.kiteworks.com/rest/dli/folders/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "id": "f0e1d2c3-b4a5-6789-0fed-cba987654321", "name": "Q1 Reports", "created": "2023-11-01T08:00:00Z", "modified": "2024-02-14T12:30:00Z", "deleted": false, "parentId": "root-folder-guid", "permalink": "https://example.com/w/f0e1d2c3" }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/mail/{id}/attachments

List email attachments

Returns a paginated list of all attachments for the specified email, including each attachment's ID, name, size, MIME type, and content fingerprint.

Parameters

Path Parameters

Required

string

The unique identifier of the email containing the attachment.

Query Parameters

ref

Optional

string

The reference code for the email. Required if the email can be accessed without authentication.

offset

Optional

integer

Offset

limit

Optional

integer

Limit

locate_id

Optional

integer

If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of email attachments retrieved successfully.

data

Attachment[]

emailPackageId

string

Unique identifier for the email package containing the attachment.

attachmentId

string

Unique identifier for the attachment.

withdrawn

boolean

Indicates whether the attachment has been withdrawn.

drmFile

object

Details of the DRM-protected file associated with the attachment.

name

string

Name of the DRM-protected file.

size

integer

Size of the DRM-protected file in bytes.

accessType

integer

Access type for the attachment (e.g., read-only, editable).

tags

Tag[]

List of tags associated with the attachment.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

permissions

Permission[]

List of permissions associated with the attachment.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

objectId

string

Unique identifier for the file associated with the attachment.

name

string

Name of the attachment file.

size

integer

Size of the attachment file in bytes.

mime

string

The MIME type of the attachment file.

created

string

Date when the attachment file was created.

deleted

boolean

Indicates if the attachment has been deleted.

fingerprint

string

A unique hash identifying the file version.

fingerprintAlgo

string

The algorithm used for generating the file version fingerprint. (e.g., sha3-256, md5).

fingerprints

Fingerprint[]

List of alternative fingerprints for the attachment file.

algo

string

The algorithm used to generate the fingerprint (e.g., sha3-256, md5).

hash

string

The resulting hash value representing the fingerprint of the file or object.

adminQuarantineStatus

string

Status of the attachment in the admin quarantine system.

avStatus

string

Antivirus (AV) scan status of the attachment.

dlpStatus

string

Data Loss Prevention (DLP) status of the attachment.

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/mail/:id/attachments" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # The unique identifier of the email containing the attachment.

url = f"https://{{instance}}.kiteworks.com/rest/dli/mail/{id}/attachments"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "attachmentId": "att-guid-001", "name": "invoice.pdf", "size": 51200, "mime": "application/pdf", "fingerprint": "abc123def456", "created": "2024-03-15T09:00:00Z", "deleted": false, "emailPackageId": "p1a2b3c4-d5e6-7890-abcd-ef1234567890" } ], "metadata": { "total": 1, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/mail/{id}/recipients

List Recipients

Returns a paginated list of all recipients (To, CC, and BCC) for the specified email, including each recipient's user ID, email address, and recipient type.

Parameters

Path Parameters

Required

string

ID of the email

Query Parameters

type

Optional

string[]

Filter recipients by type. Accepted values: 0, 1, 2.

ref

Optional

string

The reference ID of the email (Mandatory if the email can be accessed without authentication).

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

locate_id

Optional

integer

If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of email recipients retrieved successfully.

data

Recipient[]

userId

string

Unique identifier of the user associated with the recipient.

type

integer

Recipient type.
0 – To.
1 – CC.
2 – BCC.

string

Email address of the recipient.

isDistributionList

boolean

Indicates if the recipient is a distribution list rather than an individual user.

user

object

Details of the user associated with the recipient.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/mail/:id/recipients" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the email

url = f"https://{{instance}}.kiteworks.com/rest/dli/mail/{id}/recipients"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "email": "alice@example.com", "type": 1 }, { "userId": "u2b3c4d5-e6f7-8901-bcde-f12345678901", "email": "bob@example.com", "type": 2 } ], "metadata": { "total": 2, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/users/{id}/activities

Return the list of all activities of the specified user

Returns all activities performed by or on behalf of the specified user. Each activity includes the affected object, a human-readable message, the acting user, and whether the action was successful. Requires admin privileges.

Parameters

Path Parameters

Required

string

ID of the user

Query Parameters

noDayBack

Optional

integer

Number of days back to search

startDate

Optional

string

Start date

endDate

Optional

string

End date

filter

Optional

string

Filter activities by scope. Accepted values: all, my.

Optional

string

Search by mail body, subject and sender/recipients

type

Optional

string

Filter activities by type. Accepted values: all, folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint.

transactionId

Optional

string

Transaction ID associated with the activities

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of user activities retrieved successfully.

data

ActivityAdmin[]

created

string

Activity creation date

data

string[]

Contains information about affected entities

permissions

string[]

List of actions allowed for the user on the object in the activity

event

Required

string

Activity event name

Required

integer

Unique Activity identifier

message

Required

string

User-friendly message

type

Required

string

Activity type. Accepted values: folder_changes, file_changes, user_preferences, mail, tasks, comments, kitepoint, admin

user

Required

string

User associated with the activity

successful

integer

Indicates whether the activity was successful

object

string[]

Contains information about the affected file or folder

directUser

string[]

Direct user associated with the activity

inDirectUsers

string[]

Indirect users associated with the activity

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/users/:id/activities" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the user

url = f"https://{{instance}}.kiteworks.com/rest/dli/users/{id}/activities"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

GET/rest/dli/users/{id}/mail

Retrieve information about the mail specified be a user

Returns a paginated list of all emails sent or received by the specified user, including emails where the user is the sender and emails where the user appears as a recipient.

Parameters

Path Parameters

Required

string

ID of the user

Query Parameters

senderId

Optional

string

Unique identifier of User who sent Email

senderId:in

Optional

string

Unique identifier of User who sent Email. Search for results that match any of the specified values for this parameter.

isRecipient

Optional

boolean

Filter emails where the current user is a recipient.

read

Optional

boolean

Whether the email is read or not by the current user.

date

Optional

string

Email creation date

date:gt

Optional

string

Email creation date. Search for results where this parameter value is greater than the specified value.

date:gte

Optional

string

Email creation date. Search for results where this parameter value is greater than or equal to the specified value.

date:lt

Optional

string

Email creation date. Search for results where this parameter value is less than the specified value.

date:lte

Optional

string

Email creation date. Search for results where this parameter value is less than or equal to the specified value.

modified_date

Optional

string

Email modification date

modified_date:gt

Optional

string

Email modification date. Search for results where this parameter value is greater than the specified value.

modified_date:gte

Optional

string

Email modification date. Search for results where this parameter value is greater than or equal to the specified value.

modified_date:lt

Optional

string

Email modification date. Search for results where this parameter value is less than the specified value.

modified_date:lte

Optional

string

Email modification date. Search for results where this parameter value is less than or equal to the specified value.

deleted

Optional

boolean

Filter emails based on whether they have been deleted.

emailPackageId

Optional

string

Email Package unique identifier

emailPackageId:in

Optional

string

Email Package unique identifier. Search for results that match any of the specified values for this parameter.

templateId

Optional

integer

Email Template unique identifier

templateId:in

Optional

integer

Email Template unique identifier. Search for results that match any of the specified values for this parameter.

status

Optional

string[]

Filter emails by status. Accepted values: sent, draft, queued, error, self_send, transferring.

isPreview

Optional

boolean

Whether the email is a preview email

isUserSent

Optional

boolean

Whether the email was sent by some user

bucket

Optional

string

Filter emails by bucket. Accepted values: draft, inbox, outgoing, sent, trash.

returnCustomWebForm

Optional

boolean

Return all emails including those with the custom web form.

customWebFormOnly

Optional

boolean

Return only emails with the custom web form

webFormId

Optional

string

Email web form ID

webFormId:contains

Optional

string

Email web form ID. Search for results that contain the specified characters in this parameter.

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

locate_id

Optional

integer

If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

List of emails retrieved successfully.

data

Email[]

Required

string

Email unique identifier

senderId

Required

string

Unique identifier of User who sent Email

templateId

integer

Email template unique identifier

status

Required

string

Email status. Accepted values: sent, draft, queued, transferring, error, self_send

type

Required

string

Email type. Accepted values: original, resend, forward, reply

date

Required

string

Date and time the email was created

deleted

boolean

Indicates whether the email is deleted

emailPackageId

Required

string

Email Package unique identifier

isPreview

boolean

Indicates whether the email is a preview email

isUserSent

boolean

Indicates whether the email was sent by a user

watermark

string

The watermark on the preview email

package

Package

(Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier of the email package.

selfCopy

boolean

Indicates whether the package includes a copy for the sender.

includeFingerprint

boolean

Indicates whether a fingerprint (hash) of the package should be included for verification.

expire

integer

Expiration time of the package in seconds from creation.

fileCount

any

Count of the files attached to the package.

deleted

boolean

Indicates whether the package has been marked as deleted.

acl

string

Access control list (ACL) associated with the package, specifying who can access it.

attachments

Attachment[]

List of attachments included in the package.

emailPackageId

string

Unique identifier for the email package containing the attachment.

attachmentId

string

Unique identifier for the attachment.

withdrawn

boolean

Indicates whether the attachment has been withdrawn.

drmFile

object

Details of the DRM-protected file associated with the attachment.

accessType

integer

Access type for the attachment (e.g., read-only, editable).

tags

Tag[]

List of tags associated with the attachment.

permissions

Permission[]

List of permissions associated with the attachment.

objectId

string

Unique identifier for the file associated with the attachment.

name

string

Name of the attachment file.

size

integer

Size of the attachment file in bytes.

mime

string

The MIME type of the attachment file.

created

string

Date when the attachment file was created.

deleted

boolean

Indicates if the attachment has been deleted.

fingerprint

string

A unique hash identifying the file version.

fingerprintAlgo

string

The algorithm used for generating the file version fingerprint. (e.g., sha3-256, md5).

fingerprints

Fingerprint[]

List of alternative fingerprints for the attachment file.

adminQuarantineStatus

string

Status of the attachment in the admin quarantine system.

avStatus

string

Antivirus (AV) scan status of the attachment.

dlpStatus

string

Data Loss Prevention (DLP) status of the attachment.

downloadLink

string

Link for accessing the email.

expirationDate

string

Email package expiration date

attachmentCount

integer

Number of attachments in the email package

sender

UserBasicInfo

Sender's basic information (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

recipients

Required

Recipient[]

userId

string

Unique identifier of the user associated with the recipient.

type

integer

Recipient type.
0 – To.
1 – CC.
2 – BCC.

string

Email address of the recipient.

isDistributionList

boolean

Indicates if the recipient is a distribution list rather than an individual user.

user

object

Details of the user associated with the recipient.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

variables

string[]

secureBody

boolean

Indicates whether the email body is secured

modifiedDate

Required

string

Date and time the email was last modified

parentEmailId

Required

string

Unique identifier of the original email this email was forwarded or replied from

emailReturnReceipt

EmailReturnReceipt[]

mailId

Required

integer

Email unique identifier for return receipt

user

UserBasicInfo

User who is associated with this return receipt record

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

userId

Required

string

User ID for Return Receipt

error

string

Error message when the email status is error

subject

Required

string

Subject line of the email as shown to recipients

body

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

rawBody

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

headline

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

notice

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

htmlBody

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

fullHtmlBody

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

emailFrom

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

isRead

boolean

Indicates whether the email has been read by the current user

bucket

string

Mailbox bucket the email belongs to. Accepted values: inbox, sent, draft, outgoing, trash

templateBody

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

webFormId

string

(Explicit field. May be retrieved only if mentioned in "with" parameter)

webFormFields

string[]

(Explicit field. May be retrieved only if mentioned in "with" parameter)

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Forbidden

Possible error codes: ERR_LICENSE_DLI, ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/dli/users/:id/mail" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # ID of the user

url = f"https://{{instance}}.kiteworks.com/rest/dli/users/{id}/mail"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": "e1a2b3c4-d5e6-7890-abcd-ef1234567890", "senderId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "subject": "Q1 Report", "status": "sent", "type": "standard", "date": "2024-03-15", "deleted": false, "emailPackageId": "p1a2b3c4-d5e6-7890-abcd-ef1234567890" } ], "metadata": { "total": 1, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_LICENSE_DLI", "message": "Feature DLI is not enabled by license" } }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

// Error - No Body

Previousdevices

NextexternalDL