Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Kiteworks

Kiteworks dli API

The dli API from Kiteworks — 18 operation(s) for dli.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kiteworks dli API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dli. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 19 operations across 18 paths, and defines 28 schemas. It is described by OpenAPI 3.0.2, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

19 operations 18 paths 28 schemas 1 DELETE17 GET1 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 19

Across 18 paths, the API surfaces 19 operations — 1 DELETE, 17 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

dli 19
GET
/rest/dli/exports
Return the list of all exports for all users
8 params → 200403490
POST
/rest/dli/exports/users/{id}
Start generating export for the specified user
3 params body → 200403422490
GET
/rest/dli/exports/{id}
Return information of an export such as status, download url, user ID, etc.
1 param → 200403490
DELETE
/rest/dli/exports/{id}
Delete the specified export.
1 param → 204403490
GET
/rest/dli/exports/{id}/content
Download the generated export.
1 param → 200403490
GET
/rest/dli/files/{fileId}/users/{userId}/activities
Return the list of Activities for this file
14 params → 200403490
GET
/rest/dli/files/{id}
Retrieve information about the file specified.
3 params → 200403490
GET
/rest/dli/files/{id}/content
Read file content
2 params → 200403490
GET
/rest/dli/files/{id}/path
Get file path
2 params → 200403490
GET
/rest/dli/files/{id}/preview
Retrieve information about the file preview.
1 param → 200403490
GET
/rest/dli/files/{id}/versions
List versions
12 params → 200403490
GET
/rest/dli/files/{id}/versions/{version_id}
Allow DLI admin to get specified version
2 params → 200403490
GET
/rest/dli/files/{id}/versions/{version_id}/content
Download specified version
3 params → 200403490
GET
/rest/dli/folders/{folderId}/users/{userId}/activities
Return the list of activities for this folder of the specified user
14 params → 200403490
GET
/rest/dli/folders/{id}
Retrieve folder information.
3 params → 200403490
GET
/rest/dli/mail/{id}/attachments
List email attachments
7 params → 200403490
GET
/rest/dli/mail/{id}/recipients
List Recipients
9 params → 200403490
GET
/rest/dli/users/{id}/activities
Return the list of all activities of the specified user
13 params → 200403490
GET
/rest/dli/users/{id}/mail
Retrieve information about the mail specified be a user
34 params → 200403490

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Folder (43 properties), Email (36 properties), Version (22 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
PushedObject
object
4 properties
Tag
object
3 properties
Export
object
Class Export
10 properties 1 required
Preview
object
Class Preview
10 properties
MetaData
object
3 properties
UserBasic
object
4 properties
Attachment
object
19 properties
Recipient
object
5 properties
Email
object
Class Email
36 properties 10 required
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 required
Folder
object
43 properties
Error
object
2 properties
Role
object
4 properties
File
object
46 properties
DrmFile
object
2 properties
ActivityAdmin
object
Class Activity
12 properties 5 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
MobileInfo
object
5 properties
Fingerprint
object
2 properties
Version
object
Class Version
22 properties 5 required
Export.Post
object
Class Export
4 properties 3 required
Member
object
14 properties
SafeEdit
object
2 properties
EmailReturnReceipt
object
Class Recipient
3 properties 2 required
Package
object
9 properties
Group
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-dli-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
AE Profile APIs.io
Kiteworks admin API
AE Profile APIs.io
Kiteworks adminRoles API
AE Profile APIs.io
Kiteworks advancedForms API
AE Profile APIs.io
Kiteworks cards API
AE Profile APIs.io
Kiteworks clientEventLogs API
AE Profile APIs.io
Kiteworks clients API
AE Profile APIs.io
Kiteworks comments API
AE Profile APIs.io
Kiteworks contacts API
AE Profile APIs.io
Kiteworks devices API
AE Profile APIs.io
Kiteworks externalDL API
AE Profile APIs.io
Kiteworks favorites API
AE Profile APIs.io
#dli
← Back to K APIs
API Details
ID
kiteworks:kiteworks-dli-api
Base URL
https://your.kiteworks.domain/rest
Docs
https://developer.kiteworks.com/api-endpoints.html
Provider
Kiteworks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network