How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kiteworks Sources API

The sources API from Kiteworks — 15 operation(s) for sources.

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

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

This API exposes 20 operations across 15 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 28.

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

20 operations 15 paths 17 schemas 3 DELETE12 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 3 DELETE, 12 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Sources 20
POST
/rest/sources
Add user ECM source
postRestSources 2 params body → 422490
GET
/rest/sources
Return user's sources
getRestSources 6 params → 200401403490
PATCH
/rest/sources/actions/lock
Lock Repositories Gateway files
patchRestSourcesActionsLock 3 params → 200490
PATCH
/rest/sources/actions/unlock
Unlock Repositories Gateway files
patchRestSourcesActionsUnlock 3 params → 200490
POST
/rest/sources/auth
Login to cloud source
postRestSourcesAuth body → 200422490
GET
/rest/sources/files/actions/transferStatus
Get kp transfer status
getRestSourcesFilesActionsTransferStatus 3 params → 200490
GET
/rest/sources/files/{id}
Get info of an Repositories Gateway file
getRestSourcesFilesById 3 params → 200490
DELETE
/rest/sources/files/{id}
Delete an Repositories Gateway file
deleteRestSourcesFilesById 3 params → 200422490
GET
/rest/sources/folders/{id}
Get info of an Repositories Gateway folder
getRestSourcesFoldersById 3 params → 200490
DELETE
/rest/sources/folders/{id}
Delete an Repositories Gateway folder
deleteRestSourcesFoldersById 1 param → 200490
GET
/rest/sources/{id}
Returns requested ECM source
getRestSourcesById 3 params → 200490
DELETE
/rest/sources/{id}
Deletes specified source
deleteRestSourcesById 1 param → 204403490
GET
/rest/sources/{id}/auth
Get url with redirect to cloud ECM auth
getRestSourcesByIdAuth 1 param → 200403490
POST
/rest/sources/{id}/auth
Login to on-premise source
postRestSourcesByIdAuth 1 param body → 200403422490
GET
/rest/sources/{id}/authStatus
Get cloud ECM auth status
getRestSourcesByIdAuthStatus 1 param → 200490
GET
/rest/sources/{id}/children
Returns the content of the specified ECM source
getRestSourcesByIdChildren 22 params → 200490
GET
/rest/sources/{id}/externalEdit
Get access token for external file edit
getRestSourcesByIdExternalEdit 28 params → 200490
GET
/rest/sources/{id}/folders
Returns the list of folders of the specified ECM folder
getRestSourcesByIdFolders 21 params → 200490
GET
/rest/sources/{id}/preview
Get file preview metadata for a file in Repositories Gateway source
getRestSourcesByIdPreview 1 param → 200403490
GET
/rest/sources/{parent}/files
Returns the list of files of the specified ECM folder
getRestSourcesByParentFiles 21 params → 200403490

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are SourceFile (29 properties), SourceFolder (21 properties), SourceContent (20 properties), KPTransferStatus (9 properties). Each schema is shown below with its type and property counts.

KPTransferStatus
object
Class KPTransferStatus
9 properties 6 required
Error
object
2 properties
MetaData
object
3 properties
Sources
object
1 property
Source.Post
object
Class Source
8 properties 3 required
SourceContent
object
Class SourceContent - if you need true EAPI entity use App\Entity\ECObject
20 properties 5 required
CloudSourceLogin.Post
object
Class CloudSourceLogin
4 properties 2 required
Source
object
8 properties
SourceFolder
object
21 properties 5 required
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 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
OnPremiseSourceLogin.Post
object
Class OnPremiseSourceLogin
2 properties 2 required
EcmAuth
object
Class EcmAuth
2 properties
SourceFile
object
29 properties 5 required
RefreshToken
object
Class RefreshToken
4 properties 2 required
Errors
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-sources-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks Activities API
Kiteworks Admin API
Kiteworks Advanced Forms API
Kiteworks Cards API
Kiteworks Client Event Logs API
Kiteworks Clients API
Kiteworks Comments API
Kiteworks Contacts API
Kiteworks Devices API
Kiteworks Dli API
Kiteworks External DL API
Kiteworks Favorites API
Where this information came from

This is an independent, third-party profile of Kiteworks Sources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.