mobileSync

10 endpoints

POST/rest/files/actions/mobileSyncItems

Add multiple files to mobile sync list

Adds multiple files to the current user's mobile sync list in a single request. Supports partial success, meaning valid items are processed even if some fail. This operation will not return location headers for each entity created, if the inserted records are
required, returnEntity should be set to true.

Parameters

Query Parameters

id:in

Required

string

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.

partialSuccess

Optional

boolean

If set to true, the operation will continue for the valid items even if some items result in failure.

returnEntity

Optional

boolean

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

mode

Optional

string

Determines the detail level of the response body.

Responses

Mobile sync items created successfully.

data

MobileSync[]

integer

Unique identifier of MobileSync

fileId

string

Unique identifier (UUID) of the synced file.

userId

string

pushUserId

string

created

string

Mobile sync item creation date

fingerprint

string

MD5 file fingerprint

fingerprints

Fingerprint[]

List of all file fingerprints

algo

string

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

hash

string

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

secure

boolean

Indicates that File is in secure Folder

toBeNotified

boolean

Indicates that Email notification for this item was sent

pushedObject

object

Details of the push operation for this sync item, if applicable.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

syncedObject

object

Details of the sync operation for this item, if applicable.

objectId

string

Unique identifier (UUID) for the synced object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushUser

object

Details of the user who added this file to the sync list.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

avStatus

string

Antivirus (AV) scan status of the synced file.

dlpStatus

string

Data Loss Prevention (DLP) scan status of the synced file.

file

object

Details of the synced file.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

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

hash

string

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

clientCreated

string

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

clientModified

string

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

overriddenExpire

boolean

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

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

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

fileLifetime

integer

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

description

string

The description of the folder.

isFavorite

boolean

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

pushedFilesCount

integer

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

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

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

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

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

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

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

pathIds

string

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

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

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

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

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

freeSpace

integer

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

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

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

avStatus

string

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

dlpStatus

string

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

adminQuarantineStatus

string

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

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

pathIds

string

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

wopiapp

object

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

wopiSrc

string

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

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

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

schemeSupport

string

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

pushed

boolean

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

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Conflict

Possible error codes: ERR_ENTITY_EXISTS

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X POST \
  "https://{instance}.kiteworks.com/rest/files/actions/mobileSyncItems?id:in=VALUE" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

url = "https://{instance}.kiteworks.com/rest/files/actions/mobileSyncItems"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
params = {
    "id:in": "VALUE",
}
response = requests.post(url, params=params, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": 10, "fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "created": "2024-04-01T09:00:00Z" }, { "id": 11, "fileId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "created": "2024-04-01T09:00:00Z" } ], "metadata": { "total": 2, "limit": 50, "offset": 0 } }

{ "errors": { "code": "ERR_ENTITY_EXISTS", "message": "Entity exists" } }

// Error - No Body

DELETE/rest/files/actions/mobileSyncItems

Delete multiple files from user mobile sync list

Removes multiple files from the current user's mobile sync list in a single request. Supports partial success, meaning valid items are processed even if some fail.

Parameters

Query Parameters

id:in

Required

string

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.

partialSuccess

Optional

boolean

If set to true, the operation will continue for the valid items even if some items result in failure.

mode

Optional

string

Determines the detail level of the response body.

Responses

Mobile sync items removed successfully.

Empty response body.

Forbidden

Possible error codes: ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X DELETE \
  "https://{instance}.kiteworks.com/rest/files/actions/mobileSyncItems?id:in=VALUE" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

url = "https://{instance}.kiteworks.com/rest/files/actions/mobileSyncItems"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
params = {
    "id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())

Responses

// Request successful - No Body

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

// Error - No Body

POST/rest/files/actions/push

Push files list to mobile sync list

Adds multiple files to the mobile sync list for all members of the files' parent folder. Requires mobile sync to be enabled. Supports partial success, meaning valid items are processed even if some fail. This operation will not return location headers for each entity created, if the inserted records are
required, returnEntity should be set to true.

Parameters

Query Parameters

id:in

Required

string

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.

partialSuccess

Optional

boolean

If set to true, the operation will continue for the valid items even if some items result in failure.

returnEntity

Optional

boolean

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

mode

Optional

string

Determines the detail level of the response body.

Responses

Files pushed to mobile sync list successfully.

data

MobileSync[]

integer

Unique identifier of MobileSync

fileId

string

Unique identifier (UUID) of the synced file.

userId

string

pushUserId

string

created

string

Mobile sync item creation date

fingerprint

string

MD5 file fingerprint

fingerprints

Fingerprint[]

List of all file fingerprints

algo

string

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

hash

string

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

secure

boolean

Indicates that File is in secure Folder

toBeNotified

boolean

Indicates that Email notification for this item was sent

pushedObject

object

Details of the push operation for this sync item, if applicable.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

syncedObject

object

Details of the sync operation for this item, if applicable.

objectId

string

Unique identifier (UUID) for the synced object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushUser

object

Details of the user who added this file to the sync list.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

avStatus

string

Antivirus (AV) scan status of the synced file.

dlpStatus

string

Data Loss Prevention (DLP) scan status of the synced file.

file

object

Details of the synced file.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

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

hash

string

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

clientCreated

string

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

clientModified

string

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

overriddenExpire

boolean

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

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

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

fileLifetime

integer

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

description

string

The description of the folder.

isFavorite

boolean

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

pushedFilesCount

integer

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

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

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

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

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

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

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

pathIds

string

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

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

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

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

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

freeSpace

integer

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

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

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

avStatus

string

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

dlpStatus

string

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

adminQuarantineStatus

string

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

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

pathIds

string

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

wopiapp

object

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

wopiSrc

string

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

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

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

schemeSupport

string

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

pushed

boolean

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

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Request blocked by WAF

Empty response body.

Shell

curl -X POST \
  "https://{instance}.kiteworks.com/rest/files/actions/push?id:in=VALUE" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

url = "https://{instance}.kiteworks.com/rest/files/actions/push"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
params = {
    "id:in": "VALUE",
}
response = requests.post(url, params=params, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": 20, "fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "pushUserId": "u9z8y7x6-w5v4-3210-uvwx-yz1234567890", "created": "2024-04-01T10:00:00Z" } ], "metadata": { "total": 1, "limit": 50, "offset": 0 } }

// Error - No Body

DELETE/rest/files/actions/push

Un-Push multiple files

Removes multiple files from all folder members' mobile sync list in a single request. Requires mobile sync to be enabled. Supports partial success, meaning valid items are processed even if some fail.

Parameters

Query Parameters

id:in

Required

string

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.

partialSuccess

Optional

boolean

If set to true, the operation will continue for the valid items even if some items result in failure.

mode

Optional

string

Determines the detail level of the response body.

Responses

Files removed from all folder members' mobile sync list successfully.

Empty response body.

Request blocked by WAF

Empty response body.

Shell

curl -X DELETE \
  "https://{instance}.kiteworks.com/rest/files/actions/push?id:in=VALUE" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

url = "https://{instance}.kiteworks.com/rest/files/actions/push"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
params = {
    "id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())

Responses

// Request successful - No Body

// Error - No Body

POST/rest/files/{id}/actions/push

Push file to mobile sync list

Adds the specified file to the mobile sync list for all members of the file's parent folder. Requires mobile sync to be enabled.

Parameters

Path Parameters

Required

string

The unique identifier of the file

Query Parameters

returnEntity

Optional

boolean

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

mode

Optional

string

Determines the detail level of the response body.

Responses

File pushed to mobile sync list successfully.

data

MobileSync[]

integer

Unique identifier of MobileSync

fileId

string

Unique identifier (UUID) of the synced file.

userId

string

pushUserId

string

created

string

Mobile sync item creation date

fingerprint

string

MD5 file fingerprint

fingerprints

Fingerprint[]

List of all file fingerprints

algo

string

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

hash

string

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

secure

boolean

Indicates that File is in secure Folder

toBeNotified

boolean

Indicates that Email notification for this item was sent

pushedObject

object

Details of the push operation for this sync item, if applicable.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

syncedObject

object

Details of the sync operation for this item, if applicable.

objectId

string

Unique identifier (UUID) for the synced object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushUser

object

Details of the user who added this file to the sync list.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

avStatus

string

Antivirus (AV) scan status of the synced file.

dlpStatus

string

Data Loss Prevention (DLP) scan status of the synced file.

file

object

Details of the synced file.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

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

hash

string

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

clientCreated

string

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

clientModified

string

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

overriddenExpire

boolean

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

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

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

fileLifetime

integer

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

description

string

The description of the folder.

isFavorite

boolean

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

pushedFilesCount

integer

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

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

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

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

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

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

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

pathIds

string

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

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

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

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

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

freeSpace

integer

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

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

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

avStatus

string

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

dlpStatus

string

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

adminQuarantineStatus

string

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

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

pathIds

string

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

wopiapp

object

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

wopiSrc

string

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

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

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

schemeSupport

string

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

pushed

boolean

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

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Request blocked by WAF

Empty response body.

Shell

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

Python

import requests

id = "VALUE"  # The unique identifier of the file

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

Responses

// Error - No Body

DELETE/rest/files/{id}/actions/push

Un-Push file from mobile sync list

Removes the specified file from all folder members' mobile sync list. Requires mobile sync to be enabled.

Parameters

Path Parameters

Required

string

The unique identifer (UUID) of the file

Query Parameters

returnEntity

Optional

boolean

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

mode

Optional

string

Determines the detail level of the response body.

Responses

File removed from all folder members' mobile sync list successfully.

Empty response body.

Request blocked by WAF

Empty response body.

Shell

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

Python

import requests

id = "VALUE"  # The unique identifer (UUID) of the file

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

Responses

// Request successful - No Body

// Error - No Body

GET/rest/mobileSyncItems

List mobile sync items for the current user

Description:

Returns a paginated list of mobile sync items belonging to the current user.

Precondition:

User must be authenticated. The tenant must not be suspended and the license must not be expired.

Response:

Returns a list of mobile sync items for the current user.

Parameters

Query Parameters

returnEntity

Optional

boolean

If true, includes the entity in the response body.

with

Optional

string

Specifies additional fields to include in the response.

mode

Optional

string

Determines the detail level of the response body.

avStatus

Optional

string

Filter results by antivirus scan status. Accepted values: allowed, disallowed, scanning.

dlpStatus

Optional

string

Filter results by DLP scan status. Accepted values: allowed, disallowed, scanning.

orderBy

Optional

string

Sort order for the results. Default is created:desc.
Allowed values: created:asc, created:desc.

limit

Optional

integer

Range limit.

offset

Optional

integer

Range offset.

Responses

The list of mobile sync items has been successfully returned.

data

MobileSync[]

List of mobile sync items.

integer

Unique identifier of MobileSync

fileId

string

Unique identifier (UUID) of the synced file.

userId

string

pushUserId

string

created

string

Mobile sync item creation date

fingerprint

string

MD5 file fingerprint

fingerprints

Fingerprint[]

List of all file fingerprints

algo

string

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

hash

string

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

secure

boolean

Indicates that File is in secure Folder

toBeNotified

boolean

Indicates that Email notification for this item was sent

pushedObject

object

Details of the push operation for this sync item, if applicable.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

syncedObject

object

Details of the sync operation for this item, if applicable.

objectId

string

Unique identifier (UUID) for the synced object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushUser

object

Details of the user who added this file to the sync list.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

avStatus

string

Antivirus (AV) scan status of the synced file.

dlpStatus

string

Data Loss Prevention (DLP) scan status of the synced file.

file

object

Details of the synced file.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

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

hash

string

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

clientCreated

string

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

clientModified

string

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

overriddenExpire

boolean

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

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

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

fileLifetime

integer

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

description

string

The description of the folder.

isFavorite

boolean

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

pushedFilesCount

integer

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

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

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

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

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

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

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

pathIds

string

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

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

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

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

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

freeSpace

integer

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

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

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

avStatus

string

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

dlpStatus

string

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

adminQuarantineStatus

string

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

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

pathIds

string

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

wopiapp

object

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

wopiSrc

string

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

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

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

schemeSupport

string

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

pushed

boolean

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

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

metadata

object

Pagination metadata for the result set.

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

error

Error[]

code

string

Error code

message

string

Error message

Forbidden

Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_USER, ERR_ENTITY_DELETED

error

Error[]

code

string

Error code

message

string

Error message

Unprocessable Content

Possible error codes: ERR_LICENSE_EXPIRED

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

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

Python

import requests

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

Responses

{ "data": [ { "id": 1, "fileId": "string", "userId": "string", "pushUserId": "string", "created": "2024-01-15", "fingerprint": "string" } ], "metadata": {} }

{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }

{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }

{ "errors": [ { "code": "ERR_SYSTEM_TENANT_SUSPENDED", "message": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access." } ] }

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

{ "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] }

{ "errors": [ { "code": "ERR_LICENSE_EXPIRED", "message": "License has expired" } ] }

// Error - No Body

POST/rest/mobileSyncItems

Set file as a mobile sync item

Adds the specified file to the current user's mobile sync list.

Parameters

Query Parameters

returnEntity

Optional

boolean

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

mode

Optional

string

Determines the detail level of the response body.

Request Body

fileId

Required

integer

Unique identifier of File

addLinks

boolean

Indicates whether HATEOAS links should be included in the response

Responses

Mobile sync item created successfully.

integer

Unique identifier of MobileSync

fileId

string

Unique identifier (UUID) of the synced file.

userId

string

pushUserId

string

created

string

Mobile sync item creation date

fingerprint

string

MD5 file fingerprint

fingerprints

Fingerprint[]

List of all file fingerprints

algo

string

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

hash

string

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

secure

boolean

Indicates that File is in secure Folder

toBeNotified

boolean

Indicates that Email notification for this item was sent

pushedObject

object

Details of the push operation for this sync item, if applicable.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

syncedObject

object

Details of the sync operation for this item, if applicable.

objectId

string

Unique identifier (UUID) for the synced object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushUser

object

Details of the user who added this file to the sync list.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

avStatus

string

Antivirus (AV) scan status of the synced file.

dlpStatus

string

Data Loss Prevention (DLP) scan status of the synced file.

file

object

Details of the synced file.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

role

object

Role details assigned to the member.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

group

object

Group details if the member belongs to a group.

integer

LDAP Group ID

name

string

LDAP Group name

string

LDAP Group domain name

string

LDAP Group email

description

string

LDAP Group description

sharedBy

object

Details of the user who shared the file or folder.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

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

hash

string

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

clientCreated

string

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

clientModified

string

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

overriddenExpire

boolean

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

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

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

fileLifetime

integer

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

description

string

The description of the folder.

isFavorite

boolean

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

pushedFilesCount

integer

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

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

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

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

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

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

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

pathIds

string

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

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

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

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

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

freeSpace

integer

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

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

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

avStatus

string

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

dlpStatus

string

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

adminQuarantineStatus

string

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

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pathIds

string

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

wopiapp

object

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

wopiSrc

string

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

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

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

schemeSupport

string

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

pushed

boolean

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

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

Unprocessable Content

Possible error codes: ERR_INPUT_REQUIRED

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X POST \
  "https://{instance}.kiteworks.com/rest/mobileSyncItems" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "fileId": 1,
         "addLinks": true
       }'

Python

import requests

url = "https://{instance}.kiteworks.com/rest/mobileSyncItems"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "fileId": 1,
  "addLinks": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

{ "id": 10, "fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "userId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "pushUserId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890", "created": "2024-04-01T09:00:00Z", "fingerprint": "abc123def456" }

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

// Error - No Body

GET/rest/mobileSyncItems/{id}

Return a mobile sync item

Description:

Returns information about the specified mobile sync item belonging to the current user.

Precondition:

User must be authenticated and must own the specified mobile sync item. The tenant must not be suspended and the license must not be expired.

Response:

Returns the specified mobile sync item.

Parameters

Path Parameters

Required

integer

The unique identifier of the entity.

Query Parameters

returnEntity

Optional

boolean

If true, includes the entity in the response body.

with

Optional

string

Specifies additional fields to include in the response.

mode

Optional

string

Determines the detail level of the response body.

Responses

The mobile sync item has been successfully returned.

integer

Unique identifier of MobileSync

fileId

string

Unique identifier (UUID) of the synced file.

userId

string

pushUserId

string

created

string

Mobile sync item creation date

fingerprint

string

MD5 file fingerprint

fingerprints

Fingerprint[]

List of all file fingerprints

algo

string

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

hash

string

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

secure

boolean

Indicates that File is in secure Folder

toBeNotified

boolean

Indicates that Email notification for this item was sent

pushedObject

object

Details of the push operation for this sync item, if applicable.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

syncedObject

object

Details of the sync operation for this item, if applicable.

objectId

string

Unique identifier (UUID) for the synced object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushUser

object

Details of the user who added this file to the sync list.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

avStatus

string

Antivirus (AV) scan status of the synced file.

dlpStatus

string

Data Loss Prevention (DLP) scan status of the synced file.

file

object

Details of the synced file.

string

Unique identifier (UUID) of the file.

parentId

string

Unique identifier (UUID) of the parent folder.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the file.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the file.

path

string

Path to the object in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

role

object

Role details assigned to the member.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

group

object

Group details if the member belongs to a group.

integer

LDAP Group ID

name

string

LDAP Group name

string

LDAP Group domain name

string

LDAP Group email

description

string

LDAP Group description

sharedBy

object

Details of the user who shared the file or folder.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

modifier

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

size

integer

The size of the file in bytes.

mime

string

The MIME type of the file.

fingerprint

string

A unique hash identifying the file.

fingerprints

Fingerprint[]

List of fingerprints associated with the file.

algo

string

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

hash

string

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

clientCreated

string

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

clientModified

string

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

overriddenExpire

boolean

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

sharedBy

object

The user who shared the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

sharedTime

string

The date and time when the file was shared.

parent

object

The parent folder of the file.

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

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

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

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

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

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

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

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

source

integer

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

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

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

fileLifetime

integer

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

description

string

The description of the folder.

isFavorite

boolean

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

pushedFilesCount

integer

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

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

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

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

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

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

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

pathIds

string

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

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

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

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

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

freeSpace

integer

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

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

originalFileId

string

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

avStatus

string

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

dlpStatus

string

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

adminQuarantineStatus

string

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

locked

boolean

Indicates if the file is locked.

lockUser

object

The user who locked the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

isShared

boolean

Indicates if the file is shared with other users.

lastModifiedBy

object

The user who last modified the file.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pushedObject

object

Details about the pushed object, if any.

objectId

string

Unique identifier (UUID) for the pushed object.

userId

string

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

created

string

The date and time when the object was pushed.

user

object

Details of the user who pushed the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

pathIds

string

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

wopiapp

object

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

wopiSrc

string

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

userId

string

Unique identifier of the user.

service

string

The WOPI service ID.

scheme

string

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

schemeSupport

string

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

pushed

boolean

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

tags

Tag[]

List of tags associated with the file.

guid

string

Unique identifier (UUID) for the tag.

name

string

Display name of the tag.

type

string

Type category of the tag.

safeEdit

object

Information regarding the file's SafeEdit settings.

safeEditLocked

boolean

Indicates if the file is locked through a SafeEdit session.

user

object

The user responsible for locking the file via SafeEdit.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

versionsCount

integer

The total number of versions for the file.

tracking_id

string

Tracking identifier associated with the file upload.

Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED

error

Error[]

code

string

Error code

message

string

Error message

Forbidden

Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_USER, ERR_ENTITY_DELETED

error

Error[]

code

string

Error code

message

string

Error message

Unprocessable Content

Possible error codes: ERR_LICENSE_EXPIRED

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

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

Python

import requests

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

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

Responses

{ "id": 1, "fileId": "string", "userId": "string", "pushUserId": "string", "created": "2024-01-15", "fingerprint": "string" }

{ "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] }

{ "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] }

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

{ "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] }

{ "errors": [ { "code": "ERR_LICENSE_EXPIRED", "message": "License has expired" } ] }

// Error - No Body

DELETE/rest/mobileSyncItems/{id}

Remove mobile sync item

Removes the specified item from the current user's mobile sync list.

Parameters

Path Parameters

Required

integer

ID of the mobile sync item to be removed

Responses

Mobile sync item removed successfully.

Empty response body.

Forbidden

Possible error codes: ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

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

Python

import requests

id = "VALUE"  # ID of the mobile sync item to be removed

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

Responses

// Request successful - No Body

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

// Error - No Body

Previousmail

Nextnotifications