Kiteworks system API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include system. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
10 operations
across 6 paths,
and defines 11 schemas.
It is described by OpenAPI 3.0.2, at version 28.
Requests are made against the base URL https://your.kiteworks.domain/rest.
10 operations6 paths11 schemas2 DELETE5 GET3 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 10
Across 6 paths, the API surfaces 10 operations — 2 DELETE, 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
system 10
GET
/rest/nodeHealth/status
Get node health status for system monitoring
→ 200503490500
POST
/rest/system/epgdb/import/{id}
Upload EPGDB backup chunk for database restore
1 parambody→ 200401403422503507490
POST
/rest/system/epgdb/import
Upload EPGDB backup for database restore
body→ 200401403422503507490
GET
/rest/system/epgdb/import
Get EPGDB import status
→ 200401403422490
DELETE
/rest/system/epgdb/import
Cancel active EPGDB import session
→ 200401403490
GET
/rest/system/epgdb/export/{filename}
Download EPGDB export file
1 param→ 200401403490
POST
/rest/system/epgdb/export
Start EPGDB export
→ 200401403404507490
GET
/rest/system/epgdb/export
Get EPGDB export status
→ 200401403490
DELETE
/rest/system/epgdb/export
Perform cleanup for EPGDB export
→ 200401403490
GET
/rest/nodeHealth/{node_id}/metrics/{metric_name}
Get node health metrics for specified metric type
2 params→ 200401422500490
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are KwDatabaseMetric (9 properties), JobQueuedMetric (8 properties), WebRequestsMetric (6 properties), SystemResourcesMetric (6 properties). Each schema is shown below with its type and property counts.
Errors
object
1 property
WebRequestsMetric
object
6 properties
NodeHealthMetricResponse
object
5 properties
EpgdbImportPost
object
1 property
NodeHealthStatusResponse
object
1 property
Error
object
2 properties
JobQueuedMetric
object
8 properties
SftpMetric
object
2 properties
EpgdbImportRequest
object
1 property1 required
KwDatabaseMetric
object
9 properties
SystemResourcesMetric
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
