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

Kiteworks devices API

The devices API from Kiteworks — 6 operation(s) for devices.

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

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

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

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

9 operations 6 paths 7 schemas 2 DELETE4 GET1 PATCH1 POST1 PUT

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 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

devices 9
GET
/rest/devices
List devices
11 params → 200490
POST
/rest/devices
Register a device
2 params body → 200403409422490
PATCH
/rest/devices/me/actions/wipe
Report wipe completed
→ 200490
GET
/rest/devices/{id}
Get a device
1 param → 200490
PUT
/rest/devices/{id}
Update a device
1 param body → 200403422490
DELETE
/rest/devices/{id}
Delete a device
1 param → 204403490
GET
/rest/devices/{install_tag_id}/wipe
Get the wipe status
1 param → 200490
GET
/rest/users/{id}/devices
List devices for a user
1 param → 200490
DELETE
/rest/devices/me/actions/logout
Log out the current user
→ 200401490

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Device (8 properties), Device.Post (6 properties), MetaData (3 properties), Device.Put (3 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
Device.Post
object
Class Device
6 properties
Device
object
Class Device
8 properties 4 required
Error
object
2 properties
Device.Put
object
Class Device
3 properties
Logout
object
1 property
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-devices-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks dli API
Kiteworks externalDL API
Kiteworks favorites API