Kiteworks files API
The files API from Kiteworks — 61 operation(s) for files.
Kiteworks files API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 74 operations across 61 paths, and defines 57 schemas. It is described by OpenAPI 3.0.2, at version 28.
Requests are made against the base URL https://your.kiteworks.domain/rest.
74 operations
61 paths
57 schemas
11 DELETE28 GET7 PATCH25 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 74
Across 61 paths, the API surfaces 74 operations — 11 DELETE, 28 GET, 7 PATCH, 25 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
files 74
DELETE
/rest/files
Delete files
POST
/rest/files/actions/copy
Copy files
PATCH
/rest/files/actions/lock
Lock files
POST
/rest/files/actions/mobileSyncItems
Add multiple files to mobile sync list
DELETE
/rest/files/actions/mobileSyncItems
Delete multiple files from user mobile sync list
POST
/rest/files/actions/move
Move files
DELETE
/rest/files/actions/permanent
Delete files permanently
POST
/rest/files/actions/push
Push files list to mobile sync list
DELETE
/rest/files/actions/push
Un-Push multiple files
PATCH
/rest/files/actions/recover
Recover deleted files
POST
/rest/files/actions/scan
Scan files for security
PATCH
/rest/files/actions/unlock
Unlock files
GET
/rest/files/actions/zip
Download files and folders in ZIP format
GET
/rest/files/actions/zipStatus
Get file and folder security status
GET
/rest/files/{id}
Get file metadata
PUT
/rest/files/{id}
Update a file
DELETE
/rest/files/{id}
Delete a file
POST
/rest/files/{id}
Upload a file version
PATCH
/rest/files/{id}/actions/lock
Lock a file
DELETE
/rest/files/{id}/actions/permanent
Permanently delete a file
POST
/rest/files/{id}/actions/push
Push file to mobile sync list
DELETE
/rest/files/{id}/actions/push
Un-Push file from mobile sync list
PATCH
/rest/files/{id}/actions/recover
Recover a file.
PATCH
/rest/files/{id}/actions/return
Check file into Repositories Gateway source
POST
/rest/files/{id}/actions/scan
Scan a file for security
PATCH
/rest/files/{id}/actions/unlock
Unlock a file
GET
/rest/files/{id}/comments
Get file comments
POST
/rest/files/{id}/comments
Add file comment
GET
/rest/files/{id}/content
Download a file
GET
/rest/files/{id}/externalEdit
Get access token for external file edit.
GET
/rest/files/{id}/members
Get users with access to a shared file
DELETE
/rest/files/{id}/members
Remove all access to a shared file
GET
/rest/files/{id}/members/ldapGroup
List LDAP groups with access to a shared file
GET
/rest/files/{id}/members/ldapGroup/{ldap_group_id}
Get a specific LDAP group's access to a shared file
GET
/rest/files/{id}/members/{member_user_id}
Returns the specified user member associated with the file.
PUT
/rest/files/{id}/members/{member_user_id}
Update file member
DELETE
/rest/files/{id}/members/{member_user_id}
Remove a user's access to a shared file
GET
/rest/files/{id}/path
Get file path
GET
/rest/files/{id}/preview
Get file preview metadata
GET
/rest/files/{id}/tasks
Get file tasks
POST
/rest/files/{id}/tasks
Create file task
POST
/rest/files/{id}/versions
Upload a file version
GET
/rest/files/{id}/versions
Get file versions
GET
/rest/files/{id}/versions/{version_id}
Get a file version
DELETE
/rest/files/{id}/versions/{version_id}
Delete a file version
POST
/rest/files/{id}/versions/{version_id}/actions/promote
Promote a file version
POST
/rest/files/{id}/versions/{version_id}/actions/scan
Scan a file version for security
GET
/rest/files/{id}/versions/{version_id}/content
Download a file version
GET
/rest/files/{id}/versions/{version_id}/preview
Get file preview metadata for a file version
POST
/rest/folders/{id}/actions/file
Upload a file using multipart form data
POST
/rest/folders/{id}/actions/fileBase64Encoded
Upload a base64-encoded file
POST
/rest/folders/{parent_id}/actions/fileFromTemplate
Create Microsoft Office document from template
POST
/rest/folders/{parent}/files
Upload a file
GET
/rest/permissions/file/{file_id}
Get file permissions
GET
/rest/permissions/files
Get file permissions for a set of files
POST
/rest/requestFile/{ref}/actions/file
Upload a file requested by user
POST
/rest/requestFile/{ref}/comment/{object_id}
Add a comment to an uploaded file
GET
/rest/requestFile/{ref}/sources/{object_id}/content
Download files from folder in request files to folder message
GET
/rest/requestFile/{ref}/uploads/{object_id}/content
Download files uploaded to request files to folder or inbox message
GET
/rest/sources/actions/downloadByTransaction
Download a file from Repositories Gateway source by transaction ID
POST
/rest/sources/actions/files/{id}
Upload a file version to Repositories Gateway source
POST
/rest/sources/{id}/actions/file
Upload a file to Repositories Gateway source
POST
/rest/sources/{id}/actions/initiateDownload
Download a file asynchronously from Repositories Gateway source
GET
/rest/sources/{id}/content
Download a file from repositories gateway source
GET
/rest/sources/{id}/preview
Get file preview metadata for a file in Repositories Gateway source
GET
/rest/files/actions/content/link/{ref}
Download a file via a reference link
GET
/preview/file/{id}
Preview a file
POST
/rest/files/members
Share files
GET
/rest/files/shared
Get shared files
DELETE
/rest/files/{id}/members/me
Remove access to shared file
GET
/rest/files/previewSupport
Get file preview status
POST
/rest/files/actions/downloadLink
Get link for downloading files and folders
PUT
/rest/admin/files
Update files
POST
/rest/admin/files/{id}/actions/rescan
Scan a file for security
Schemas 57
The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Folder (43 properties), SourceFile (29 properties), Requirement (22 properties). Each schema is shown below with its type and property counts.
Errors
object
1 property
Requirement
object
22 properties
FolderFileAddMembers
object
3 properties
FileLockPostRequest
object
1 property
FilePreviewSupport
object
1 property
PushedObject
object
4 properties
BulkOperationLockFile
object
3 properties
Tag
object
3 properties
Content.Post
object
Class Content
7 properties
2 required
MobileSync
object
15 properties
DownloadLink
object
1 property
Preview
object
Class Preview
10 properties
MetaData
object
3 properties
FileNameRequest.Post
object
2 properties
UserBasic
object
4 properties
ErrorStringSchemaAccessVerifications
object
6 properties
UserMetadata
object
Class UserMetadata
2 properties
PostFileZipStatusBodyRequest
object
4 properties
Task
object
Class Task
17 properties
6 required
AccessVerificationApproval
object
20 properties
Members
object
2 properties
AdminFileRescan
object
1 property
Permission
object
3 properties
UserBasicInfo
object
4 properties
3 required
FilePermissions
object
Class FilePermissions
2 properties
Folder
object
43 properties
Task.Post
object
Class Task
5 properties
3 required
Error
object
2 properties
AdminFilePutRequest
object
2 properties
1 required
MemberGroup
object
Class MemberGroup
9 properties
3 required
Role
object
4 properties
KPTransferStatus
object
Class KPTransferStatus
9 properties
6 required
File
object
46 properties
Comment.Post
object
Class Comment
3 properties
1 required
Files
object
1 property
RiskPolicy
object
20 properties
FileMembersPostRequest
object
6 properties
1 required
FilePathResponse
object
Represents the full ancestor path of a file, from the workspace root down to the file's parent folder. Returned by the GET /files/{id}/path endpoint.
2 properties
SourceContent
object
Class SourceContent - if you need true EAPI entity use App\Entity\ECObject
20 properties
5 required
SourcePreviewStatus
object
Represents the preview generation status for a file in a Repositories Gateway source. Returned by the GET /sources/{id}/preview endpoint (v15+).
3 properties
SourceFile
object
29 properties
5 required
FileUpdateRequest
object
3 properties
Fingerprint
object
2 properties
MobileInfo
object
5 properties
User
object
Class User
22 properties
6 required
LdapGroup
object
Class LdapGroup
5 properties
2 required
SyncedObject
object
4 properties
ErrorString
object
4 properties
Version
object
Class Version
22 properties
5 required
RefreshToken
object
Class RefreshToken
4 properties
2 required
Member
object
14 properties
SafeEdit
object
2 properties
FileMovePostBodyRequest
object
3 properties
1 required
Group
object
5 properties
BaseObject
object
Class Object
17 properties
4 required
FileCopyPostBodyRequest
object
4 properties
1 required
Comment
object
Class Comment
15 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kiteworks 12
Other APIs Kiteworks publishes across the network.
Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API
#files