Kiteworks uploads API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include uploads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
11 operations
across 10 paths,
and defines 20 schemas.
It is described by OpenAPI 3.0.2, at version 28.
Requests are made against the base URL https://your.kiteworks.domain/rest.
11 operations10 paths20 schemas1 DELETE3 GET7 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.2
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1
Paths & Operations 11
Across 10 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.
uploads 11
GET
/rest/uploads
Retrieve all user upload sessions
5 params→ 200490
GET
/rest/uploads/config
Get upload server configuration
→ 200490
GET
/rest/uploads/{id}
Get upload session
3 params→ 200490
DELETE
/rest/uploads/{id}
Terminate upload session
1 param→ 204490
POST
/rest/folders/{id}/actions/initiateUpload/zip
Initiate a ZIP archive upload session for a folder
1 parambody→ 201400401403413422490
POST
/rest/folders/{id}/actions/initiateUpload
Initiate a file upload session for a folder
1 parambody→ 201400401403413422490
POST
/rest/requestFile/{ref}/actions/initiateUpload
Initiate a file upload session for a request file
1 parambody→ 201400401403413422490
POST
/rest/mail/{id}/actions/initiateUpload
Initiate a file upload session for an email attachment
1 parambody→ 201400401403413422490
POST
/rest/public/mail/{id}/actions/initiateUpload
Initiate an unauthenticated file upload session for an email attachment
1 parambody→ 201400401403413422490
POST
/rest/files/{id}/actions/initiateUpload
Initiate an upload session for a new file version
1 parambody→ 201400401403413422490
POST
/{host_name}/rest/uploads/{id}
Upload a file chunk
5 paramsbody→ 200201400401403422490
Schemas 20
The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Folder (43 properties), Upload (23 properties), Member (14 properties). Each schema is shown below with its type and property counts.
Errors
object
1 property
Upload
object
23 properties
PushedObject
object
4 properties
Tag
object
3 properties
InitiateUploadZipPostRequest
object
9 properties2 required
MetaData
object
3 properties
InitiateUploadPostRequest
object
8 properties1 required
UserBasic
object
4 properties
BaseChunkUploadRequest
object
6 properties4 required
AcfsConfig
object
Class AcfsConfig
7 properties
Permission
object
3 properties
Folder
object
43 properties
Error
object
2 properties
Role
object
4 properties
File
object
46 properties
MobileInfo
object
5 properties
Fingerprint
object
2 properties
Member
object
14 properties
SafeEdit
object
2 properties
Group
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
