Delete files
Deletes the specified files. Depending on the system retention policy, the files may be
recoverable until permanently deleted by the system.
Requires file_delete permission
on the parent folder for each file.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
Files successfully deleted.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())Copy files
Description:
Copies the specified files to a folder.Precondition:
Must be assigned the `file_copy` permission for the files being copied and `file_add` permission for the destination folder.Response:
Copies the files to the folder. If duplicate files exist, appends a number to copied file names.If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
Comma-separated list of file UUIDs to copy. Cannot be used together with ids in the request body.
If true, successfully copied files are committed even if some files fail to copy.
List of file UUIDs to copy. Cannot be used together with id:in in the query string.
UUID of the destination folder to copy the files into.
If true, overwrites existing files in the destination folder if they share the same name.
New name for the copied file. Only applicable when copying a single file into the same folder to avoid a name conflict.
Files have been copied successfully.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED, ERR_ENTITY_DELETED, ERR_ENTITY_COPIED_FROM_EC, ERR_ENTITY_EC_TO_EC, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR
Error code
Error message
Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/actions/copy" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
],
"destinationFolderId": "string",
"replace": true,
"newFileName": "string"
}'import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/copy"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
],
"destinationFolderId": "string",
"replace": true,
"newFileName": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Lock files
Description:
Locks the specified files, preventing others from performing actions such as editing, moving, and deleting the files.Precondition:
Must be assigned the `lock` permission for the files.Response:
Locks the files.A comma-separated list of unique identifier (UUID) of the objects to be processed.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
If set to true, the operation will continue for the valid items even if some items result in failure.
A list of file object IDs to be locked/unlocked.
The files have been successfully locked.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
List of IDs for successfully locked files.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_ATTACHMENT, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/actions/lock" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}'import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/lock"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())Move files
Description:
Moves the specified files to a folder.Precondition:
Must be assigned the `file_move` permission for the files being moved and the `file_add` permission for the destination folder.Response:
Moves the files to the folder.If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
Comma-separated list of file UUIDs to move. Cannot be used together with ids in the request body.
If true, successfully moved files are committed even if some files fail to move.
List of file UUIDs to move. Cannot be used together with id:in in the query string.
UUID of the destination folder to move the files into.
If true, overwrites existing files in the destination folder if they share the same name.
Files have been moved successfully.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED, ERR_ENTITY_DELETED, ERR_ENTITY_COPIED_FROM_EC, ERR_ENTITY_EC_TO_EC, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR
Error code
Error message
Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/actions/move" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
],
"destinationFolderId": "string",
"replace": true
}'import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/move"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
],
"destinationFolderId": "string",
"replace": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Delete files permanently
Permanently deletes the specified files. Files cannot be recovered after this operation.
Requires permanent delete permission on the parent folder for each file. Each file must
already be in the deleted state and must not be locked.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
All specified files permanently deleted.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/actions/permanent?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/permanent"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())Recover deleted files
Recovers the specified deleted files, restoring them to their parent folders.
Requires
file_recover permission on the parent folder for each file. Each file must be in the
deleted state and must not be permanently deleted.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the recovered files with their restored status.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/actions/recover?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/recover"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.patch(url, params=params, headers=headers)
print(response.json())Scan files for security
Queues security scans for the specified files. Depending on system scan policies, files are
scanned for anti-virus threats, data loss prevention (DLP) violations, and advanced threat
protection. Scans run asynchronously.
Requires view permission on each file. Files
must not be deleted.
If set to true, returns information about the newly created entity.
List of IDs of entities to scan. Search for results that match any of the specified values for this parameter.
With parameters
Determines the detail level of the response body.
Returns the files for which security scans were queued.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/actions/scan" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/scan"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())Unlock files
Description:
Unlocks the specified files, enabling others to perform actions such as edit, move, and delete the files.Precondition:
Must be assigned the `unlock` permission for the files.Response:
Unlocks the files.A comma-separated list of unique identifier (UUID) of the objects to be processed.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
If set to true, the operation will continue for the valid items even if some items result in failure.
A list of file object IDs to be locked/unlocked.
The files have been successfully unlocked.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
List of IDs for successfully locked files.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_ATTACHMENT, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/actions/unlock" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}'import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/unlock"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"ids": [
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())Download files and folders in ZIP format
Downloads the specified files and folders as a ZIP archive. Folder contents are included
recursively. Optionally filtered by file extension.
Requires download permission on
each file and folder. Files must not be deleted, infected, or DLP-locked.
The name for the generated ZIP archive.
A comma-separated list of file IDs to include in the ZIP archive.. Search for results that match any of the specified values for this parameter.
A comma-separated list of folder IDs to include in the ZIP archive.. Search for results that match any of the specified values for this parameter.
The email address of the user requesting the ZIP archive.
Filter files by the specified comma-separated list of extensions.
The user's timezone offset in seconds (e.g., UTC+08:00 = 28800).
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
Returns a binary ZIP archive containing the requested files and folders.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/actions/zip" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/zip"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get file and folder security status
Description:
Gets the security scan results of specified files and folders in preparation for downloading them in ZIP format.Precondition:
Must be assigned the `download` permission for the files and folders.Response:
Returns an empty response if all files are safe for download.A comma-separated list of file IDs (UUID) to check. (Recommended request size <= 100)
A comma-separated list of folder IDs (UUID) to check. (Recommended request size <= 100)
Indicates whether the operation should proceed if some files/folders fail the check.
Filter results to include only files with the specified comma-separated list of extensions.
All files and folders are verified as safe for zipping and download.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_USER, ERR_ENTITY_VIRUS_FOUND, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_DLP_SCANNING, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_LICENSE_EXPIRED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/actions/zipStatus" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/zipStatus"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get file metadata
Description:
Gets metadata for specified files, such as file owner, creation date, digital fingerprint, and security scan status.Precondition:
Must be assigned the `properties_view` permission for the file.Response:
Returns the file metadata.The unique identifier (UUID) of the entity.
UUID of the approval requirement. Required together with accessVerificationId to access a file under an approval workflow.
UUID of the access verification event. Required together with requirementId to validate approver access.
The file has been successfully returned.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_ACCESS_DENIED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Upload a file version
Uploads a new version of the specified file. The uploaded content becomes the new current version (version 0), and the previous current version is incremented. Requires version_create permission on the file.
The unique identifier (UUID) of the file
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Binary content of the file
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Returns the updated file record reflecting the newly uploaded version.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string",
"clientCreated": "string",
"clientModified": "string"
}'import requests
id = "VALUE" # The unique identifier (UUID) of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string",
"clientCreated": "string",
"clientModified": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Update a file
Description:
Updates a file's properties such as name and expiration date.Precondition:
User must have `properties_edit` permission for the file.Response:
The file is updated.The unique identifier (UUID) of the entity.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The new name for the file.
The updated expiration date for the file.
Indicates whether to replace the existing file if one with the same name already exists.
The file has been updated successfully.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_ENTITY_LOCKED, ERR_INVALID_PARAMETER, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP, ERR_ENTITY_EXISTS
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/files/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"expire": "2024-01-15",
"replace": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"name": "string",
"expire": "2024-01-15",
"replace": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete a file
Deletes the specified file. Depending on the system retention policy, the file may be
recoverable until permanently deleted by the system.
Requires delete permission on
the parent folder. The file must not be locked.
The unique identifier (UUID) of the file.
File successfully deleted.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Lock a file
Locks the specified file, preventing other users from editing, moving, or deleting it until
the lock is released.
Requires lock permission on the file. The file must not already
be locked or deleted.
The unique identifier (UUID) of the file
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the file with its updated lock status.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED
Error code
Error message
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/:id/actions/lock" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/actions/lock"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.patch(url, headers=headers)
print(response.json())Permanently delete a file
Description:
Permanently deletes the specified file. The file must have been soft-deleted first.Precondition:
The user must be the owner, manager, or collaborator of the file. The file must not be locked or safe-edit locked, unless the user is an admin. The file must have been soft-deleted via `DELETE /rest/files/{id}`.Response:
The file is permanently deleted and its content cannot be retrieved.The unique identifier (UUID) of the entity.
The file has been permanently deleted.
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED, ERR_AUTH_INVALID_CSRF
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_LOCKED, ERR_ENTITY_SAFE_EDIT_LOCKED
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/:id/actions/permanent" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/actions/permanent"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Recover a file.
Recovers the specified deleted file, restoring it to its parent folder.
Requires
recover permission on the parent folder. The file must be in the deleted state and must
not be permanently deleted.
The unique identifier (UUID) of the file
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the recovered file with its restored status.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/:id/actions/recover" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/actions/recover"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.patch(url, headers=headers)
print(response.json())Check file into Repositories Gateway source
Checks the specified file back into its Repositories Gateway source. The local copy of
the file is permanently deleted after a successful check-in. If the file is locked in
the Repositories Gateway source and the caller has unlock permission, the lock is
released automatically.
Requires view permission on the parent folder. The file
must be eligible to return to source (i.e., it was originally checked out) and must not
be infected.
The unique identifier (UUID) of the file
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the updated file metadata from the Repositories Gateway source after check-in.
Unique SourceContent identifier
Display name of the source content item
Parent source content unique identifier
Source content type. Accepted values: \d\ (folder), \f\ (file)
Creation timestamp of the source content in UTC
Last modification timestamp of the source content in UTC
Current availability status of the source content item
Indicates whether the source content is deleted
Full path of the source content
Current user role id (Explicit field. May be retrieved only if mentioned in "with" parameter)
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
WOPI info for iOS app
Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in "with" parameter)
Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of files in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique SourceContent identifier
Display name of the source content item
Parent source content unique identifier
Source content type. Accepted values: \d\ (folder), \f\ (file)
Creation timestamp of the source content in UTC
Last modification timestamp of the source content in UTC
Current availability status of the source content item
Indicates whether the source content is deleted
Full path of the source content
Current user role id (Explicit field. May be retrieved only if mentioned in "with" parameter)
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
WOPI info for iOS app
Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in "with" parameter)
Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of files in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique SourceContent identifier
Display name of the source content item
Parent source content unique identifier
Source content type. Accepted values: \d\ (folder), \f\ (file)
Creation timestamp of the source content in UTC
Last modification timestamp of the source content in UTC
Current availability status of the source content item
Indicates whether the source content is deleted
Full path of the source content
Current user role id (Explicit field. May be retrieved only if mentioned in "with" parameter)
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
WOPI info for iOS app
Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in "with" parameter)
Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of files in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique SourceContent identifier
Display name of the source content item
Parent source content unique identifier
Source content type. Accepted values: \d\ (folder), \f\ (file)
Creation timestamp of the source content in UTC
Last modification timestamp of the source content in UTC
Current availability status of the source content item
Indicates whether the source content is deleted
Full path of the source content
Current user role id (Explicit field. May be retrieved only if mentioned in "with" parameter)
File's creator (Explicit field. May be retrieved only if mentioned in "with" parameter)
Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)
WOPI info for iOS app
Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in "with" parameter)
Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in "with" parameter)
Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of files in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in "with" parameter)
Class SourceContent - if you need true EAPI entity use App\Entity\ECObject
HATEOAS links associated with the entity
HATEOAS links associated with the entity
HATEOAS links associated with the entity
HATEOAS links associated with the entity
Indicates whether the file is locked
Size of the source file in bytes
File content fingerprint
Date and time after which the source file expires and becomes unavailable
File MIME type
Check file availability status according to AV settings and file scanned/infected status
Check file availability status according to DLP settings and file scanned/infected status
Username/email of user who locked the file
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/:id/actions/return" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/actions/return"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.patch(url, headers=headers)
print(response.json())Scan a file for security
Queues a security scan for the specified file. Depending on system scan policies, the file
is scanned for anti-virus threats, data loss prevention (DLP) violations, and advanced threat
protection. The scan runs asynchronously.
Requires view permission on the file.
The file must not be deleted.
The unique identifier (UUID) of the file
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the file for which the security scan was queued.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/:id/actions/scan" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/actions/scan"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())Unlock a file
Unlocks the specified file, allowing other users to edit, move, and delete it.
Requires unlock permission on the file. The file must currently be locked.
The unique identifier (UUID) of the file
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the file with its updated lock status.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED_BY_ANOTHER_USER, ERR_ENTITY_UNLOCKED
Error code
Error message
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/files/:id/actions/unlock" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/actions/unlock"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.patch(url, headers=headers)
print(response.json())Download a file
Description:
Downloads the specified file.Precondition:
Must be assigned the `download` permission for the file.Response:
Downloads the file to the specified location.The unique identifier (UUID) of the entity.
Range of bytes to download. e.g. bytes=0-1024
The file download request was successful.
The file was partially downloaded.
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/content" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/content"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get access token for external file edit.
Retrieves a short-lived refresh token scoped to the specified file, authorizing an external
editor to download the current version and upload a new version.
Requires file_add
permission on the parent folder. The file must not be permanently deleted. Users with
Collaborator, Downloader, or Viewer roles cannot edit files in restricted folders.
The unique identifier of the file
With parameters
Determines the detail level of the response body.
Returns a short-lived refresh token with the scope and expiration required for external file editing.
Unique identifier of the user to whom the refresh token belongs
Date and time after which the refresh token is no longer valid
OAuth scope of the refresh token
Refresh token value
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/externalEdit" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/externalEdit"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get users with access to a shared file
Description:
Gets a list of users with access to the specified shared file. Also gets the file metadata, providing context and information about the shared file such as each user's role for accessing the file and the user who shared the file.Precondition:
File sharing must be activated on the system. Must be assigned the `user_view` permission for the shared file.Response:
Returns the list of users with access to the shared file, along with metadata about the shared file.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| id | The member ID |
| userId | The user ID |
| groupId | The group ID |
| roleId | The role ID |
The unique identifier (UUID) of the entity.
Filter results by user ID (UUID).
Filter results by LDAP group ID.
Filter results by role ID.
Filter by a comma-separated list of user IDs (UUID). (Recommended request size <= 100)
Filter by a comma-separated list of LDAP Group IDs. (Recommended request size <= 100)
Filter by a comma-separated list of role IDs.
Filter members by the object type they have access to.f – File membership.d – Directory (folder) membership.
Sort order for the results. Default is id:asc.
Allowed values: id:asc, id:desc, userId:asc, userId:desc, groupId:asc, groupId:desc, roleId:asc, roleId:desc, rank:asc, rank:desc, email:asc, email:desc.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The file members have been successfully returned.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_USER_TYPE_NO_ACCESS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_LICENSE_EXPIRED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/members" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Remove all access to a shared file
Description:
Removes user access to the specified shared file.Precondition:
Must be assigned the `user_add` permission for the folder containing the shared file.Response:
Removes user access to the shared file.The unique identifier (UUID) of the entity.
All file members have been successfully removed.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/:id/members" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())List LDAP groups with access to a shared file
Returns a list of LDAP groups and their assigned roles for the folder containing the specified file. Requires the user_view permission on the shared file.
ID of the file
The unique identifier of the group.
The unique identifier of the group.. Search for results that match any of the specified values for this parameter.
The unique identifier of the role.
The unique identifier of the role.. Search for results that match any of the specified values for this parameter.
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
Returns a paginated list of LDAP groups that have been granted access to the folder containing the specified file, including each group's assigned role.
Unique identifier of the folder this member belongs to
Unique identifier of the role assigned to this member
LDAP group unique identifier
Display name of the LDAP group
LDAP group email address
LDAP group description
HATEOAS links associated with the entity
Role ID
Role name
Role rank
Role type
Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in "with" parameter)
List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Unique identifier of the LDAP group assigned as a member
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/members/ldapGroup" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members/ldapGroup"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get a specific LDAP group's access to a shared file
Returns the access grant record for the specified LDAP group on the folder containing the file, including the group's assigned role. Requires the user_view permission on the shared file.
ID of the file
The unique identifier of the LDAP group.
With parameters
Determines the detail level of the response body.
Returns the access grant record for the specified LDAP group, including its assigned role for the file's folder.
Unique identifier of the folder this member belongs to
Unique identifier of the role assigned to this member
LDAP group unique identifier
Display name of the LDAP group
LDAP group email address
LDAP group description
HATEOAS links associated with the entity
Role ID
Role name
Role rank
Role type
Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in "with" parameter)
List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Unique identifier of the LDAP group assigned as a member
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/members/ldapGroup/:ldap_group_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the file
ldap_group_id = "VALUE" # The unique identifier of the LDAP group.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members/ldapGroup/{ldap_group_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Returns the specified user member associated with the file.
Returns the name of the specified user with access to the specified shared file. Also gets metadata, providing context and information about the user such as their ID, email address, and role for accessing the file. Must be assigned the user_view permission for the shared file.
The unique identifier (UUID) of the file.
The unique identifier of the user member.
With parameters
Determines the detail level of the response body.
Returns the specified user member and their role for the file.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/members/:member_user_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file.
member_user_id = "VALUE" # The unique identifier of the user member.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members/{member_user_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update file member
Description:
Changes the role assigned to the specified user for accessing the specified shared file.Precondition:
Must be assigned the `user_add` permission for the folder containing the file.Response:
Changes the user's role to the specified role.The unique identifier (UUID) of the entity.
The unique identifier (UUID) of the user.
The file member's role has been successfully updated.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ACCESS_USER, ERR_ENTITY_DELETED
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS, ERR_ENTITY_ROLE_IS_ASSIGNED, ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/files/:id/members/:member_user_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
member_user_id = "VALUE" # The unique identifier (UUID) of the user.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members/{member_user_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.put(url, headers=headers)
print(response.json())Remove a user's access to a shared file
Description:
Removes the specified user's access to the specified shared file.Precondition:
Must be assigned the `user_add` permission for the folder containing the shared file.Response:
Removes the user's access to the shared file.The unique identifier (UUID) of the entity.
The unique identifier (UUID) of the user.
The member has been successfully removed from the file.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/:id/members/:member_user_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
member_user_id = "VALUE" # The unique identifier (UUID) of the user.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members/{member_user_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Get file path
Returns the full ancestor path of the specified file, from the workspace root down to the
file's parent folder. Each element in the path represents a folder node with its ID and
name.
Requires properties_view permission on the file.
The unique identifier of the file
Determines the detail level of the response body.
Returns the full ancestor path of the file as an ordered list of folder nodes.
Ordered list of folder nodes representing the path from the workspace root to the file's parent folder.
Optional HATEOAS links. Present only when the request includes link options.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/path" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the file
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/path"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get file preview metadata
Description:
Gets file preview metadata about the specified file, such as the permalink for previewing the file and if the file contains a watermark.Precondition:
Must be assigned the `view` permission for the file.Response:
Returns the file preview metadata.The unique identifier (UUID) of the entity.
The file preview information has been successfully returned.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED, ERR_ENTITY_DELETED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/preview" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/preview"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get file tasks
Gets a list of tasks assigned to the specified file. Requires task_view permission on the file's parent folder.
The unique identifier (UUID) of the file.
Assigned User unique identifier
Assigned User unique identifier. Search for results that match any of the specified values for this parameter.
Task due date
Task due date. Search for results where this parameter value is greater than the specified value.
Task due date. Search for results where this parameter value is greater than or equal to the specified value.
Task due date. Search for results where this parameter value is less than the specified value.
Task due date. Search for results where this parameter value is less than or equal to the specified value.
Parent Comment identifier
Parent Comment identifier. Search for results that match any of the specified values for this parameter.
Identifier of User who created a Task
Identifier of User who created a Task. Search for results that match any of the specified values for this parameter.
Task creation date
Task creation date. Search for results where this parameter value is greater than the specified value.
Task creation date. Search for results where this parameter value is greater than or equal to the specified value.
Task creation date. Search for results where this parameter value is less than the specified value.
Task creation date. Search for results where this parameter value is less than or equal to the specified value.
Task modification date
Task modification date. Search for results where this parameter value is greater than the specified value.
Task modification date. Search for results where this parameter value is greater than or equal to the specified value.
Task modification date. Search for results where this parameter value is less than the specified value.
Task modification date. Search for results where this parameter value is less than or equal to the specified value.
Task content. Search for results that contain the specified characters in this parameter.
Filter tasks by status. Accepted values: D, P, C.
Whether the task has been deleted
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
Returns a paginated list of tasks associated with the specified file.
Task unique identifier
Assigned User unique identifier
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Date and time by which the task must be completed
Parent Comment identifier
Object identifier Task belongs to
Identifier of User who created a Task
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Date and time the task was created
Date and time the task was last modified
Body text of the task
Indicates whether the task is deleted
Identifier of Object's parent Folder
Task status. Accepted values: D (Defined), P (In Progress), C (Completed)
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
The role of the current user in this folder.
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Details of the user who pushed the object.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
The user responsible for locking the file via SafeEdit.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
HATEOAS links associated with the entity
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/tasks" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/tasks"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Create file task
Creates a task for the specified file and assigns it to a user. The assignee must have at least properties_view permission on the file's parent folder. Requires task_add permission on the file's parent folder.
Object ID of the file task is created on
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Assignee user unique identifier
Date and time by which the task must be completed
Parent Comment identifier
Body text of the task
Indicates whether HATEOAS links should be included in the response
Returns the newly created task record.
Task unique identifier
Assigned User unique identifier
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Date and time by which the task must be completed
Parent Comment identifier
Object identifier Task belongs to
Identifier of User who created a Task
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Date and time the task was created
Date and time the task was last modified
Body text of the task
Indicates whether the task is deleted
Identifier of Object's parent Folder
Task status. Accepted values: D (Defined), P (In Progress), C (Completed)
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
HATEOAS links associated with the entity
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED, ERR_INPUT_DATE_NOT_AFTER, ERR_INPUT_HTML_TAGS_INVALID
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/:id/tasks" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"assigneeId": 1,
"due": "2024-01-15",
"parentId": 1,
"contents": "string",
"addLinks": true
}'import requests
id = "VALUE" # Object ID of the file task is created on
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/tasks"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"assigneeId": 1,
"due": "2024-01-15",
"parentId": 1,
"contents": "string",
"addLinks": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Get file versions
Gets a list of file versions for the specified file. Also gets the file metadata, such as its owner, creation date, digital fingerprint, and security scan status. Requires version_view permission on the file.
The unique identifier (UUID) of the file.
File Version creation date
File Version creation date. Search for results where this parameter value is greater than the specified value.
File Version creation date. Search for results where this parameter value is greater than or equal to the specified value.
File Version creation date. Search for results where this parameter value is less than the specified value.
File Version creation date. Search for results where this parameter value is less than or equal to the specified value.
Sorting options
Offset
Limit
If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.
With parameters
Determines the detail level of the response body.
Returns a paginated list of version records for the specified file.
The unique identifier of the file version.
The version number of the file.
Indicates whether this version of the file has been deleted.
The creation date of this file version.
The unique identifier of the user who created this file version.
The size of the file content in bytes.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The backend system associated with the file version.
The MIME type of the file version.
The name of the file version.
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
The object ID (UUID) for the file version.
The date and time the file version was created on the client side.
The date and time the file version was last modified on the client side.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version\'s availability status based on the administrator\'s quarantine status.
Indicates whether the file is accessible on any storage volume.
A list of fingerprints associated with the file version.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
HATEOAS links associated with the entity
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/versions" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Upload a file version
Uploads a new version of the specified file using streaming upload, where the file content is sent in the request body. Requires the version_create permission on the target file. Returns the updated file entity.
The unique identifier of the file (UUID) to which the version is being uploaded.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
The binary content of the file.
New file version uploaded successfully.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/:id/versions" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string"
}'import requests
id = "VALUE" # The unique identifier of the file (UUID) to which the version is being uploaded.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Get a file version
Gets file metadata for the specified file version, such as the date it was added, its expiration date, and any tags applied to the file. Requires version_view permission on the file.
The unique identifier (UUID) of the file.
The unique identifier (UUID) of the file version.
Returns the metadata for the specified file version.
The unique identifier of the file version.
The version number of the file.
Indicates whether this version of the file has been deleted.
The creation date of this file version.
The unique identifier of the user who created this file version.
The size of the file content in bytes.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The backend system associated with the file version.
The MIME type of the file version.
The name of the file version.
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
The object ID (UUID) for the file version.
The date and time the file version was created on the client side.
The date and time the file version was last modified on the client side.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version\'s availability status based on the administrator\'s quarantine status.
Indicates whether the file is accessible on any storage volume.
A list of fingerprints associated with the file version.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
HATEOAS links associated with the entity
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/versions/:version_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the file.
version_id = "VALUE" # The unique identifier (UUID) of the file version.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions/{version_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Delete a file version
Deletes the specified version of the file. Cannot delete the last remaining version of a file. Requires version_delete permission on the file.
The unique identifier of the file.
The unique identifier (UUID) of the file version.
The version was successfully deleted. Returns no content.
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_LOCKED
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/:id/versions/:version_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the file.
version_id = "VALUE" # The unique identifier (UUID) of the file version.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions/{version_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Promote a file version
Makes the specified version of the file the current version of the file. The promoted version is assigned version number 0 (current), and all lower-numbered versions are incremented. Also updates the file name to match the promoted version. Requires version_promote permission on the file.
The unique identifier (UUID) of file
The unique identifier (UUID) of the file version.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the promoted version record after it has been set as the current version.
The unique identifier of the file version.
The version number of the file.
Indicates whether this version of the file has been deleted.
The creation date of this file version.
The unique identifier of the user who created this file version.
The size of the file content in bytes.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The backend system associated with the file version.
The MIME type of the file version.
The name of the file version.
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
The object ID (UUID) for the file version.
The date and time the file version was created on the client side.
The date and time the file version was last modified on the client side.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version\'s availability status based on the administrator\'s quarantine status.
Indicates whether the file is accessible on any storage volume.
A list of fingerprints associated with the file version.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
HATEOAS links associated with the entity
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_LOCKED
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/:id/versions/:version_id/actions/promote" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of file
version_id = "VALUE" # The unique identifier (UUID) of the file version.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions/{version_id}/actions/promote"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())Scan a file version for security
Triggers a security scan on the specified file version. Depending on system scan policies, the scan may include anti-virus, data loss prevention, and advanced threat protection checks. Requires version_view permission on the file.
The unique identifier (UUID) of file
The unique identifier (UUID) of the file version.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the version record after the scan has been triggered. The scan result is reflected in the avStatus and dlpStatus fields once the scan completes.
The unique identifier of the file version.
The version number of the file.
Indicates whether this version of the file has been deleted.
The creation date of this file version.
The unique identifier of the user who created this file version.
The size of the file content in bytes.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The backend system associated with the file version.
The MIME type of the file version.
The name of the file version.
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
The object ID (UUID) for the file version.
The date and time the file version was created on the client side.
The date and time the file version was last modified on the client side.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version\'s availability status based on the administrator\'s quarantine status.
Indicates whether the file is accessible on any storage volume.
A list of fingerprints associated with the file version.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
HATEOAS links associated with the entity
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/:id/versions/:version_id/actions/scan" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of file
version_id = "VALUE" # The unique identifier (UUID) of the file version.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions/{version_id}/actions/scan"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())Download a file version
Downloads the binary content of the specified file version. Requires download permission on the file. Users assigned the Downloader or Viewer role can only download the current version (version 0); attempting to download an older version returns a 403.
The unique identifier (UUID) of file
The unique identifier (UUID) of the file version.
Range of bytes to download. e.g. bytes=0-1024
Returns the binary content of the file version as an octet-stream. Supports range requests via the Range header; a partial-content request returns HTTP 206.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/versions/:version_id/content" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of file
version_id = "VALUE" # The unique identifier (UUID) of the file version.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions/{version_id}/content"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get file preview metadata for a file version
Gets file preview metadata for the specified file version, such as the permalink for previewing the file and if the file contains a watermark. Requires view permission on the file.
The unique identifier of the file.
The unique identifier (UUID) of the file version.
Returns the preview metadata for the specified file version.
Preview link for the file
PDF file for the preview
URL for viewing the preview
Preview processing status. Accepted values: processing, preview, failed
Format of the generated preview, such as image or PDF
Additional metadata about the preview, such as dimensions or page count
MIME type of the preview file
Indicates whether the preview is a native render
Watermark applied to the preview
Original file extension for TDF files
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/:id/versions/:version_id/preview" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the file.
version_id = "VALUE" # The unique identifier (UUID) of the file version.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/versions/{version_id}/preview"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Upload a file using multipart form data
Uploads a file to the specified folder using multipart form data. If a file with the same
name already exists, a new version is created unless disableAutoVersion is set.
Requires file_add permission on the target folder (or version_create if a file with
the same name already exists). The folder must not be deleted. Sufficient storage must be
available. The file extension and MIME type must not be excluded by the system policy.
The unique identifier (UUID) of the target folder.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
The binary content of the file.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates if the file should be prevented from being saved as a new version.
Indicates if the file should be uploaded as a note.
Returns the uploaded file metadata.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/file" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string",
"clientCreated": "string",
"clientModified": "string",
"disableAutoVersion": true,
"note": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the target folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/file"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string",
"clientCreated": "string",
"clientModified": "string",
"disableAutoVersion": true,
"note": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Upload a base64-encoded file
Uploads a base64-encoded file to the specified folder. If a file with the same name already
exists, a new version is created unless disableAutoVersion is set.
Requires
file_add permission on the target folder (or version_create if a file with the same
name already exists). The file content must be valid base64. The file size must not exceed
the system-configured upload size limit. The file extension must not be excluded by the
system policy.
The unique identifier (UUID) of the target folder.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Indicates whether HATEOAS links should be included in the response
Display name of the file
Raw content body of the file being created
Date and time when the file was created on the client side
Date and time when the file was last modified on the client side
Indicates whether the file should be uploaded as a note
Indicates whether the file should be prevented from being saved as a new version
Returns the uploaded file metadata.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/fileBase64Encoded" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"addLinks": true,
"name": "string",
"content": "string",
"clientCreated": 1,
"clientModified": 1,
"note": 1
}'import requests
id = "VALUE" # The unique identifier (UUID) of the target folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/fileBase64Encoded"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"addLinks": true,
"name": "string",
"content": "string",
"clientCreated": 1,
"clientModified": 1,
"note": 1
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Create Microsoft Office document from template
Creates a new, blank Microsoft Office document from a template in the specified folder.
Requires file_add permission on the target folder. The folder must not be deleted.
The file name must not contain invalid characters.
ID of the parent folder
The file type
The file name
Returns the newly created file.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_LOCKED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:parent_id/actions/fileFromTemplate" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"fileType": "string",
"fileName": "string"
}'import requests
parent_id = "VALUE" # ID of the parent folder
url = f"https://{{instance}}.kiteworks.com/rest/folders/{parent_id}/actions/fileFromTemplate"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"fileType": "string",
"fileName": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Upload a file
Uploads a file to the specified folder using streaming upload, where the file content is sent in the request body and metadata is provided via request headers. Requires the file_add permission on the target folder. Returns the created file entity.
The unique identifier (UUID) of the target folder.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Indicates if the file should be uploaded as a note.
The binary content of the file.
File uploaded successfully.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ENTITY_LOCKED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:parent/files" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string"
}'import requests
parent = "VALUE" # The unique identifier (UUID) of the target folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{parent}/files"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Get file permissions
Returns the list of actions the current user is allowed to perform on the specified file, such as downloading, editing, or commenting.
ID of the file
Unique action identifier
Unique action identifier. Search for results that match any of the specified values for this parameter.
Action name
Action name. Search for results that contain the specified characters in this parameter.
Determines if one has permissions to perform action
Determines if the given action is available considering the current object state (locked, deleted, etc.).
With parameters
Determines the detail level of the response body.
File permissions retrieved successfully.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/permissions/file/:file_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
file_id = "VALUE" # ID of the file
url = f"https://{{instance}}.kiteworks.com/rest/permissions/file/{file_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get file permissions for a set of files
Returns the current user's allowed actions for each of the specified files. File IDs are passed as request parameters. Returns 400 if no file IDs are provided.
Unique identifier of the file.. Search for results that match any of the specified values for this parameter.
Action name
Action name. Search for results that contain the specified characters in this parameter.
Determines if one has permissions to perform action
Determines if the given action is available considering the current object state (locked, deleted, etc.).
Unique action identifier
Unique action identifier. Search for results that match any of the specified values for this parameter.
With parameters
Determines the detail level of the response body.
File permissions retrieved successfully.
Id of file
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/permissions/files?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/permissions/files"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.get(url, params=params, headers=headers)
print(response.json())Upload a file requested by user
Uploads a file to a folder or inbox in response to a file request from another user.
Access is granted via the request file reference link (ref). If the request requires
authentication (require_auth), the caller must be logged in. The uploaded file is
renamed to include the uploader's email address.
The request link must not be expired
or have reached its upload limit. Sufficient storage must be available in the target
folder. The file extension and MIME type must not be excluded by the requestor's system
policy.
The unique reference of the Request File upload link.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
The binary content of the file.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Returns the uploaded file metadata.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/requestFile/:ref/actions/file" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string",
"clientCreated": "string",
"clientModified": "string"
}'import requests
ref = "VALUE" # The unique reference of the Request File upload link.
url = f"https://{{instance}}.kiteworks.com/rest/requestFile/{ref}/actions/file"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string",
"clientCreated": "string",
"clientModified": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Add a comment to an uploaded file
Adds a comment to a file that was uploaded through the request file link. Only accessible when the link requires authentication (require_auth=true) and has not expired.
The unique reference of the Request File upload link.
Object ID of the file being commented on.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Unique identifier of the parent comment. Set this value when replying to an existing comment
Text content of the comment
Indicates whether HATEOAS links should be included in the response
Returns the newly created comment record.
Comment unique identifier
Unique identifier of the parent comment, if the comment is a reply
Unique identifier (UUID) of the file being commented on
Unique identifier (UUID) of the folder containing the object being commented on
Unique identifier (UUID) of the user who authored the comment
Date and time when the comment was created
Date and time when the comment was last modified
Text content of the comment
Indicates whether the comment has been deleted
Indicates whether the item is a comment
Unique identifier of object
Date and time when the object was created
Indicates whether the object is deleted
Indicates whether the object is permanently deleted
Date and time when the object expires and becomes inaccessible
Date and time when the object was last modified
Display name of the object
Parent Folder identifier
Unique identifier of Object creator
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Permanent URL for accessing the object in the web application
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)
Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)
Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)
HATEOAS links associated with the entity
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Comment unique identifier
Unique identifier of the parent comment, if the comment is a reply
Unique identifier (UUID) of the file being commented on
Unique identifier (UUID) of the folder containing the object being commented on
Unique identifier (UUID) of the user who authored the comment
Date and time when the comment was created
Date and time when the comment was last modified
Text content of the comment
Indicates whether the comment has been deleted
Indicates whether the item is a comment
Unique identifier of object
Date and time when the object was created
Indicates whether the object is deleted
Indicates whether the object is permanently deleted
Date and time when the object expires and becomes inaccessible
Date and time when the object was last modified
Display name of the object
Parent Folder identifier
Unique identifier of Object creator
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
The role of the current user in this folder.
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Permanent URL for accessing the object in the web application
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)
Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)
Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)
HATEOAS links associated with the entity
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Comment unique identifier
Unique identifier of the parent comment, if the comment is a reply
Unique identifier (UUID) of the file being commented on
Unique identifier (UUID) of the folder containing the object being commented on
Unique identifier (UUID) of the user who authored the comment
Date and time when the comment was created
Date and time when the comment was last modified
Text content of the comment
Indicates whether the comment has been deleted
Indicates whether the item is a comment
Unique identifier of object
Date and time when the object was created
Indicates whether the object is deleted
Indicates whether the object is permanently deleted
Date and time when the object expires and becomes inaccessible
Date and time when the object was last modified
Display name of the object
Parent Folder identifier
Unique identifier of Object creator
Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)
Permanent URL for accessing the object in the web application
Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)
Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)
Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)
Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)
Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)
HATEOAS links associated with the entity
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Comment unique identifier
Unique identifier of the parent comment, if the comment is a reply
Unique identifier (UUID) of the file being commented on
Unique identifier (UUID) of the folder containing the object being commented on
Unique identifier (UUID) of the user who authored the comment
Date and time when the comment was created
Date and time when the comment was last modified
Text content of the comment
Indicates whether the comment has been deleted
Indicates whether the item is a comment
Class Object
Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)
Class Comment
Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
HATEOAS links associated with the entity
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
HATEOAS links associated with the entity
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
HATEOAS links associated with the entity
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_MAX_VALUE, ERR_INPUT_HTML_TAGS_INVALID, ERR_INPUT_REQUIRED
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/requestFile/:ref/comment/:object_id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"parentId": 1,
"contents": "string",
"addLinks": true
}'import requests
ref = "VALUE" # The unique reference of the Request File upload link.
object_id = "VALUE" # Object ID of the file being commented on.
url = f"https://{{instance}}.kiteworks.com/rest/requestFile/{ref}/comment/{object_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"parentId": 1,
"contents": "string",
"addLinks": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Download files from folder in request files to folder message
Downloads a file that was made available to recipients as a source attachment in a
request files to folder message. Access is granted via the request file reference link
(ref).
The request link must be valid and not expired. If the request requires
authentication, the caller must be logged in. The file must not be deleted, infected,
or DLP-locked.
The unique reference of the Request File upload link.
The unique identifier of the file
Range of bytes to download. e.g. bytes=0-1024
Returns the binary file content as a downloadable stream.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/requestFile/:ref/sources/:object_id/content" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
ref = "VALUE" # The unique reference of the Request File upload link.
object_id = "VALUE" # The unique identifier of the file
url = f"https://{{instance}}.kiteworks.com/rest/requestFile/{ref}/sources/{object_id}/content"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Download files uploaded to request files to folder or inbox message
Downloads a file that was uploaded to a request files to folder or inbox message. Access
is granted via the request file reference link (ref).
Authentication is required
— guest access is not permitted for this endpoint. The file must be associated with the
specified request link, must not be deleted, and must not be infected or DLP-locked.
The unique reference of the Request File upload link.
The unique identifier of the file
Range of bytes to download. e.g. bytes=0-1024
Returns the binary file content as a downloadable stream.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/requestFile/:ref/uploads/:object_id/content" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
ref = "VALUE" # The unique reference of the Request File upload link.
object_id = "VALUE" # The unique identifier of the file
url = f"https://{{instance}}.kiteworks.com/rest/requestFile/{ref}/uploads/{object_id}/content"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Download a file from Repositories Gateway source by transaction ID
Downloads a file from its Repositories Gateway source using the transaction ID obtained
from POST /sources/{id}/actions/initiateDownload. The transfer must have completed
successfully before calling this endpoint.
Requires download permission on the
file.
Transaction ID of download
Determines the detail level of the response body.
Returns the binary file content as a downloadable stream.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/sources/actions/downloadByTransaction" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/sources/actions/downloadByTransaction"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Upload a file version to Repositories Gateway source
Uploads a new version of the specified file to its Repositories Gateway source. Returns a
transfer status record reflecting the result of the upload operation.
Requires
file_add permission on the Repositories Gateway parent folder of the file. The file
extension and MIME type must not be excluded by the system policy.
The unique identifier of the Repositories Gateway file to add a new version to.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
The binary content of the file.
Returns the transfer status record for the upload operation.
KP transfer status unique identifier
Unique transaction identifier for tracking the Repositories Gateway file transfer
Unique identifier of the Repositories Gateway object being transferred
File handle used to reference the temporary file during the transfer process
The unique identifier of the user.
Numeric error code returned when the file transfer fails
Current status of the Repositories Gateway file transfer. Accepted values: 0 (received request), 1 (in progress), 2 (completed successfully), 99 (transfer failed)
AV scan status. Accepted values: allowed, disallowed, scanning
DLP scan status. Accepted values: allowed, disallowed, scanning
Forbidden
Possible error codes: ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/sources/actions/files/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string"
}'import requests
id = "VALUE" # The unique identifier of the Repositories Gateway file to add a new version to.
url = f"https://{{instance}}.kiteworks.com/rest/sources/actions/files/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Upload a file to Repositories Gateway source
Uploads a file to the specified Repositories Gateway source folder. Returns a transfer
status record that reflects the result of the upload operation.
Requires file_add
permission on the target Repositories Gateway folder. The file extension and MIME type
must not be excluded by the system policy.
The unique identifier of the Repositories Gateway target folder.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
The binary content of the file.
Returns the transfer status record for the upload operation.
KP transfer status unique identifier
Unique transaction identifier for tracking the Repositories Gateway file transfer
Unique identifier of the Repositories Gateway object being transferred
File handle used to reference the temporary file during the transfer process
The unique identifier of the user.
Numeric error code returned when the file transfer fails
Current status of the Repositories Gateway file transfer. Accepted values: 0 (received request), 1 (in progress), 2 (completed successfully), 99 (transfer failed)
AV scan status. Accepted values: allowed, disallowed, scanning
DLP scan status. Accepted values: allowed, disallowed, scanning
Forbidden
Possible error codes: ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_EXTENSION_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_RESTRICTED_TYPE_CUSTOM, ERR_ENTITY_RESTRICTED_TYPE_GROUP
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/sources/:id/actions/file" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string"
}'import requests
id = "VALUE" # The unique identifier of the Repositories Gateway target folder.
url = f"https://{{instance}}.kiteworks.com/rest/sources/{id}/actions/file"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Download a file asynchronously from Repositories Gateway source
Initiates an asynchronous download of the specified file from its Repositories Gateway
source. Returns a transfer status record that can be polled via
GET /sources/actions/downloadByTransaction until the transfer completes.
Requires download permission on the file.
The unique identifier of the file from Repositories Gateway Source.
Returns the transfer status record for the initiated download, including the transaction ID used to poll for completion.
KP transfer status unique identifier
Unique transaction identifier for tracking the Repositories Gateway file transfer
Unique identifier of the Repositories Gateway object being transferred
File handle used to reference the temporary file during the transfer process
The unique identifier of the user.
Numeric error code returned when the file transfer fails
Current status of the Repositories Gateway file transfer. Accepted values: 0 (received request), 1 (in progress), 2 (completed successfully), 99 (transfer failed)
AV scan status. Accepted values: allowed, disallowed, scanning
DLP scan status. Accepted values: allowed, disallowed, scanning
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/sources/:id/actions/initiateDownload" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the file from Repositories Gateway Source.
url = f"https://{{instance}}.kiteworks.com/rest/sources/{id}/actions/initiateDownload"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())Download a file from repositories gateway source
Downloads the binary content of the specified file from its Repositories Gateway source.
Requires download permission on the file.
Repositories Gateway file id
Returns the binary file content as a downloadable stream.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/sources/:id/content" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # Repositories Gateway file id
url = f"https://{{instance}}.kiteworks.com/rest/sources/{id}/content"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Download a file via a reference link
Description:
Downloads the file identified by the provided reference link.Precondition:
Must be assigned the `download` permission for the file.Response:
The file content is streamed to the user.The unique reference for the download link.
The file download request by reference link was successful.
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/actions/content/link/:ref" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
ref = "VALUE" # The unique reference for the download link.
url = f"https://{{instance}}.kiteworks.com/rest/files/actions/content/link/{ref}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Preview a file
Description:
Returns the preview content for the specified file via the Repositories Gateway.Precondition:
User must have the `view` permission for the file.Response:
The preview content is returned.The unique identifier of the entity.
The preview content has been successfully returned.
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/preview/file/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the entity.
url = f"https://{{instance}}.kiteworks.com/preview/file/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Share files
Description:
Shares specified files with multiple users.Precondition:
Must be assigned the `user_add` permission for the folder.Response:
Shares the files with the specified users.If set to true, updates the member if they already exist and have a different folder role.
If set to true, the operation will continue for the valid items even if some items result in failure.
If set to true, demote the user member role in all applicable nested folders.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
If set to true, notifies the user being invited to the file via email.
List of email addresses for new members.
List of user IDs (UUID) for new members. (Recommended request size <= 100)
List of file UUIDs to share with the specified users.
The role to assign to the new members.8 – Collaborator (can upload, edit, and download).9 – Viewer (read-only access).
Optional message to include with the file sharing.
All files were successfully shared with the specified users.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
Access Verification ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Requirement ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
List of approvers for the requirement
Asset class associated with the requirement
List of succeeded recipient emails.
Reference ID for the error
List of succeeded IDs.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Files were partially shared — some users were added successfully while others failed.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
Access Verification ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Requirement ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
List of approvers for the requirement
Asset class associated with the requirement
List of succeeded recipient emails.
Reference ID for the error
List of succeeded IDs.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ACCESS_USER, ERR_LICENSE_MAX_USERS_COUNT_REACHED, ERR_USER_HAS_NO_USER_TYPE, ERR_USER_TYPE_NO_ACCESS, ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST, ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_IS_OWNER, ERR_ENTITY_DELETED, ERR_CLIENT_OBJECT
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS, ERR_ENTITY_ROLE_IS_ASSIGNED
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/members" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"notify": true,
"emails": [
"string"
],
"userIds": [
"string"
],
"ids": [
"string"
],
"roleId": 1,
"message": "string"
}'import requests
url = "https://{instance}.kiteworks.com/rest/files/members"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"notify": true,
"emails": [
"string"
],
"userIds": [
"string"
],
"ids": [
"string"
],
"roleId": 1,
"message": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Remove access to shared file
Description:
Removes the current user's access to the specified file that was shared with them.Precondition:
The file must have been shared with the user.Response:
Removes the user's access to the shared file.The unique identifier (UUID) of the entity.
The user has been successfully removed from the file.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/files/:id/members/me" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/members/me"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Get file preview status
Description:
Gets the status of the specified file to determine if the file type is supported for preview.Precondition:
Must be assigned the `view` permission for the folder.Response:
Returns confirmation as to whether the file type is supported for preview.Comma-separated list of file UUIDs to check for preview support.
Returns a list of unique identifiers (UUIDs) of the files supported for preview.
Unique identifier (UUID) of the supported files
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/files/previewSupport?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/files/previewSupport"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.get(url, params=params, headers=headers)
print(response.json())Get link for downloading files and folders
Description:
Generates a link for downloading specified folders and files.Precondition:
Must be assigned the download permission for the specified files and folders.Response:
A download link is generated and returned. Returns the link for downloading the files and folders, once files complete security scans. Depending on system scan policies, files will be scanned for anti-virus, data loss prevention, and advanced threat protection.Indicates whether the operation should proceed if some files/folders fail the check.
Filter results to include only files with the specified comma-separated list of extensions.
List of file UUIDs to include in the bulk download. Maximum 1000 entries.
List of folder UUIDs to include in the bulk download. Maximum 100 entries.
UUID of a single file to download. Use this for single-file downloads instead of fileIds.
The version ID of the specified file.
The download link has been successfully generated.
List of download URLs for the requested files.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/files/actions/downloadLink" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"fileIds": [
"string"
],
"folderIds": [
"string"
],
"fileId": "string",
"versionId": "string"
}'import requests
url = "https://{instance}.kiteworks.com/rest/files/actions/downloadLink"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"fileIds": [
"string"
],
"folderIds": [
"string"
],
"fileId": "string",
"versionId": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Update files
Description:
Updates the metadata of multiple files at the same time.Precondition:
Must be an administrator with access to the Files and Folders page in the Kiteworks PDN Admin.Response:
Updates the selected files.If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
List of file object IDs (UUID) to be updated.
New expiration date for the selected files.
The files have been successfully updated.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_ATTACHMENT, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_EXCEEDS_MAX_VALUE, ERR_INPUT_PAST_DATE, ERR_INVALID_PARAMETER, ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/files" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"string"
],
"expire": "2024-01-15"
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/files"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"ids": [
"string"
],
"expire": "2024-01-15"
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Scan a file for security
Description:
Runs a security scan on the specified file.Precondition:
Must authenticate as an administrator with a role allowing for manually scanning files for security.Response:
Scans the selected file for security. Depending on system scan policies, the file is scanned for anti-virus, data loss prevention, and advanced threat protection.The unique identifier (UUID) of the entity.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The file has been successfully submitted for rescan.
The successful response message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_ADMIN
Error code
Error message
Not Found
Possible error codes: ERR_ENTITY_FILE_IS_NOT_FOUND, ERR_ENABLED_SCANNING_SERVICE_IS_NOT_FOUND
Error code
Error message
Conflict
Possible error codes: ERR_SCANNING_IN_PROGRESS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/admin/files/:id/actions/rescan" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/admin/files/{id}/actions/rescan"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())