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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kiteworks

Kiteworks Admin API

The admin API from Kiteworks — 19 operation(s) for admin.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

29 operations 19 paths 38 schemas 4 DELETE16 GET4 POST5 PUT

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 29

Across 19 paths, the API surfaces 29 operations — 4 DELETE, 16 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Admin 29
GET
/rest/admin/hostnames
List hostnames
getRestAdminHostnames 14 params → 200490
DELETE
/rest/admin/hostnames
Deletes list of hostnames
deleteRestAdminHostnames 3 params → 204403490
POST
/rest/admin/hostnames
Create an alias hostname
postRestAdminHostnames 2 params body → 200409422490
GET
/rest/admin/hostnames/{id}
Returns the details of hostname of the specified ID
getRestAdminHostnamesById 1 param → 200490
PUT
/rest/admin/hostnames/{id}
Disable / enable alias hostname
putRestAdminHostnamesById 1 param body → 200403490
DELETE
/rest/admin/hostnames/{id}
Mark specified hostname as deleted
deleteRestAdminHostnamesById 1 param → 204403490
GET
/rest/admin/mail
List emails
getRestAdminMail 25 params → 200490
DELETE
/rest/admin/mail/actions/withdrawFiles/users/{userId}
Withdraw all files from the emails of deleted or demoted users
deleteRestAdminMailActionsWithdrawFilesUsersByUserId 4 params → 204403490
GET
/rest/admin/profiles
List user types (profiles)
getRestAdminProfiles 7 params → 200490
GET
/rest/admin/profiles/mappingOrder
Get profile mapping order
getRestAdminProfilesMappingOrder → 200490
PUT
/rest/admin/profiles/mappingOrder
Update profile mapping order
putRestAdminProfilesMappingOrder 2 params body → 200422490
GET
/rest/admin/profiles/mappings
Get profile mapping results for user
getRestAdminProfilesMappings 1 param → 200490
GET
/rest/admin/profiles/{id}
Return a user type
getRestAdminProfilesById 1 param → 200490
GET
/rest/admin/profiles/{id}/mappings
Get profile mapping details
getRestAdminProfilesByIdMappings 1 param → 200490
PUT
/rest/admin/profiles/{id}/mappings
Update profile mapping details
putRestAdminProfilesByIdMappings 3 params body → 200422490
GET
/rest/admin/profiles/{id}/users
Return list of users with the specified types
getRestAdminProfilesByIdUsers 24 params → 200403490
PUT
/rest/admin/profiles/{id}/users
Bulk update user types (profiles)
putRestAdminProfilesByIdUsers 3 params body → 200403422490
GET
/rest/admin/users
Get a list of Users
getRestAdminUsers 23 params → 200490
POST
/rest/admin/users
Create a User
postRestAdminUsers 2 params body → 200403422490
POST
/rest/admin/users/migrateEmails
Bulk update user emails
postRestAdminUsersMigrateEmails 2 params body → 200422490
POST
/rest/admin/users/migrateEmailsCsv
Bulk update user emails via CSV file
postRestAdminUsersMigrateEmailsCsv 2 params body → 200422490
GET
/rest/admin/users/{id}
Get User
getRestAdminUsersById 1 param → 200490
PUT
/rest/admin/users/{id}
Update User
putRestAdminUsersById 1 param body → 200403490
DELETE
/rest/admin/users/{id}
Deletes a User
deleteRestAdminUsersById 11 params → 204403422490
GET
/rest/admin/users/{id}/adminRoles
Return admin roles of the specified user id
getRestAdminUsersByIdAdminRoles 4 params → 200403490
GET
/rest/admin/users/{id}/devices
List devices for a user
getRestAdminUsersByIdDevices 12 params → 200490
GET
/rest/admin/activities
Get admin activities list
getRestAdminActivities 10 params → 200401422490
GET
/rest/admin/activities/{id}
Get admin activity detail
getRestAdminActivitiesById 1 param → 200401422490
GET
/rest/admin/activities/actions/exportCSV
Export admin activities list
getRestAdminActivitiesActionsExportCSV 10 params → 200401422490

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are FeaturesList (58 properties), Email (36 properties), User (22 properties), Attachment (19 properties). Each schema is shown below with its type and property counts.

UserBasic
object
4 properties
Error
object
2 properties
DrmFile
object
2 properties
Package
object
9 properties
Errors
object
1 property
ProfileMappings
object
Class ProfileMappings
3 properties
Recipient
object
5 properties
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 required
Attachment
object
19 properties
Hostname.Put
object
Class Hostname
2 properties
Email
object
Class Email
36 properties 10 required
ProfileMappingOrder.Put
object
Class ProfileMappingOrder
2 properties 1 required
ProfileMappingChanges
object
Class ProfileMappingChanges
1 property 1 required
UserDemoteOptions.Post
object
Class UserDemoteOptions
8 properties
ProfileMapping
object
Class ProfileMapping
4 properties 1 required
MetaData
object
3 properties
Device
object
Class Device
8 properties 4 required
ProfileMappingsTest
object
Class ProfileMappingsTest
1 property
AdminRole
object
Class AdminRole
4 properties 2 required
EmailReturnReceipt
object
Class Recipient
3 properties 2 required
UserMetadata
object
Class UserMetadata
2 properties
ActivityList
object
1 property
Profile
object
Class Profile
6 properties 5 required
User.Put
object
Class User
6 properties
Tag
object
3 properties
Activity
object
9 properties
Fingerprint
object
2 properties
Hostname
object
Class Hostname
5 properties 1 required
FeaturesList
object
Class FeaturesList
58 properties 7 required
UserEmail.Post
object
Class UserEmail
2 properties 2 required
ProfileMappingChanges.Put
object
Class ProfileMappingChanges
2 properties
User.Post
object
Class User
7 properties 1 required
Hostname.Post
object
Class Hostname
3 properties 1 required
UsersEmailMigration.Post
object
Class UsersEmailMigration
2 properties
ActivityUser
object
4 properties
User
object
Class User
22 properties 6 required
ProfileMappingOrder
object
Class ProfileMappingOrder
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-admin-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks Activities API
AE Profile APIs.io
Kiteworks Advanced Forms API
AE Profile APIs.io
Kiteworks Cards API
AE Profile APIs.io
Kiteworks Client Event Logs 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 External DL API
AE Profile APIs.io
Kiteworks Favorites API
AE Profile APIs.io
Kiteworks Files API
AE Profile APIs.io
#Admin
← Back to K APIs
API Details
ID
kiteworks:kiteworks-admin-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
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=kiteworks-admin-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kiteworks-admin-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Kiteworks Admin 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.