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 sources API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.0.2, 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.0.2
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
2 params body → 422490
GET
/rest/sources
Return user's sources
6 params → 200401403490
PATCH
/rest/sources/actions/lock
Lock Repositories Gateway files
3 params → 200490
PATCH
/rest/sources/actions/unlock
Unlock Repositories Gateway files
3 params → 200490
POST
/rest/sources/auth
Login to cloud source
body → 200422490
GET
/rest/sources/files/actions/transferStatus
Get kp transfer status.
3 params → 200490
GET
/rest/sources/files/{id}
Get info of an Repositories Gateway file.
3 params → 200490
DELETE
/rest/sources/files/{id}
Delete an Repositories Gateway file.
3 params → 200422490
GET
/rest/sources/folders/{id}
Get info of an Repositories Gateway folder.
3 params → 200490
DELETE
/rest/sources/folders/{id}
Delete an Repositories Gateway folder.
1 param → 200490
GET
/rest/sources/{id}
Returns requested ECM source
3 params → 200490
DELETE
/rest/sources/{id}
Deletes specified source
1 param → 204403490
GET
/rest/sources/{id}/auth
Get url with redirect to cloud ECM auth
1 param → 200403490
POST
/rest/sources/{id}/auth
Login to on-premise source
1 param body → 200403422490
GET
/rest/sources/{id}/authStatus
Get cloud ECM auth status
1 param → 200490
GET
/rest/sources/{id}/children
Returns the content of the specified ECM source
22 params → 200490
GET
/rest/sources/{id}/externalEdit
Get access token for external file edit.
28 params → 200490
GET
/rest/sources/{id}/folders
Returns the list of folders of the specified ECM folder
21 params → 200490
GET
/rest/sources/{id}/preview
Get file preview metadata for a file in Repositories Gateway source
1 param → 200403490
GET
/rest/sources/{parent}/files
Returns the list of files of the specified ECM folder
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.

UserBasicInfo
object
4 properties 3 required
Errors
object
1 property
Source
object
8 properties
RefreshToken
object
Class RefreshToken
4 properties 2 required
OnPremiseSourceLogin.Post
object
Class OnPremiseSourceLogin
2 properties 2 required
EcmAuth
object
Class EcmAuth
2 properties
Error
object
2 properties
Sources
object
1 property
SourceFolder
object
21 properties 5 required
KPTransferStatus
object
Class KPTransferStatus
9 properties 6 required
CloudSourceLogin.Post
object
Class CloudSourceLogin
4 properties 2 required
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
Source.Post
object
Class Source
8 properties 3 required
Permission
object
3 properties
MetaData
object
3 properties

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
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 dli API
AE Profile APIs.io
Kiteworks externalDL API
AE Profile APIs.io
#sources
← Back to K APIs
API Details
ID
kiteworks:kiteworks-sources-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