# Kiteworks Developer Portal

> Official developer documentation for the Kiteworks REST API and Kiteworks MCP Server. Covers authentication, file and folder management, secure mail, API concepts, and governed AI integration for enterprise and regulated environments.

## Getting Started

- [Kiteworks Developer Portal](https://developer.kiteworks.com/index.html) ([Markdown](https://developer.kiteworks.com/index.md)): Landing page with guides, code examples, and API version information.
- [Before You Begin](https://developer.kiteworks.com/before-you-begin.html) ([Markdown](https://developer.kiteworks.com/before-you-begin.md)): Prerequisites (REST, OAuth 2.0, JSON, HTTP), licensing requirements, and custom application registration steps.
- [Authentication](https://developer.kiteworks.com/authentication.html) ([Markdown](https://developer.kiteworks.com/authentication.md)): How to obtain access tokens using OAuth 2.0 Authorization Code flow with PKCE, or JWT Bearer assertion flow. Includes full Python implementations.
- [Quick Start](https://developer.kiteworks.com/quick-start.html) ([Markdown](https://developer.kiteworks.com/quick-start.md)): Step-by-step guide to making your first authenticated Kiteworks API call in under 10 minutes using Python.

## API Fundamentals

- [API Concepts](https://developer.kiteworks.com/api-concepts.html) ([Markdown](https://developer.kiteworks.com/api-concepts.md)): Pagination (offset/limit), result sorting, rate limiting, HTTP status codes, and error response body structure.
- [API Endpoints](https://developer.kiteworks.com/api-endpoints.html) ([Markdown](https://developer.kiteworks.com/api-endpoints.md)): Overview of all seven API endpoint categories: Content, Collaboration, Preferences, Contacts, Security, Client Management, and Maintenance.
- [API Playground](https://developer.kiteworks.com/api-playground.html) ([Markdown](https://developer.kiteworks.com/api-playground.md)): Live Python code samples, access requirements (admin rights, VPN), and network configuration (inbound IPs and outbound AWS us-west-2).
- [API Spec Downloads](https://developer.kiteworks.com/api-specs.html) ([Markdown](https://developer.kiteworks.com/api-specs.md)): Direct download links for the full OpenAPI spec files (JSON/YAML) and per-resource spec slices.

## Quick Start Guides

- [PubSub Quick Start](https://developer.kiteworks.com/pubsub-quick-start.html) ([Markdown](https://developer.kiteworks.com/pubsub-quick-start.md)): Receive real-time Kiteworks events at a URL you control — register a webhook and process your first event in under 10 minutes.

## How-To Guides

- [Manage Folders](https://developer.kiteworks.com/manage-folders.html) ([Markdown](https://developer.kiteworks.com/manage-folders.md)): List top-level folders, navigate child folders, list files in a folder, and create new folders. Uses GET /rest/folders/top and related endpoints.
- [Manage Files](https://developer.kiteworks.com/manage-files.html) ([Markdown](https://developer.kiteworks.com/manage-files.md)): List files in a folder, search by path, download file data, and upload files using the three-step chunked upload protocol.
- [Manage Mail](https://developer.kiteworks.com/manage-mail.html) ([Markdown](https://developer.kiteworks.com/manage-mail.md)): Create a mail draft, attach files using the upload URI (not the ID), and send secure email. Three sequential API calls.

## Integrations

- [Streaming Kiteworks Events to Splunk Enterprise via Webhooks](https://developer.kiteworks.com/integrations/kiteworks-events-to-splunk-via-pubsub.html) ([Markdown](https://developer.kiteworks.com/integrations/kiteworks-events-to-splunk-via-pubsub.md)): Forward Kiteworks PubSub events to Splunk Enterprise over HTTPS using the HTTP Event Collector (HEC) — configure the HEC token and a Kiteworks webhook in the Admin console, scoped to the event categories you want forwarded.
- [Sending Kiteworks Events to Microsoft Sentinel via the Logs Ingestion API](https://developer.kiteworks.com/integrations/kiteworks-events-to-sentinel-via-pubsub.html) ([Markdown](https://developer.kiteworks.com/integrations/kiteworks-events-to-sentinel-via-pubsub.md)): Stream Kiteworks PubSub events into Microsoft Sentinel via Azure's Logs Ingestion API and Data Collection Rules (Managed Identity auth) — deploy the ARM template, wire up the webhook, and migrate off the deprecated HTTP Data Collector API.

## Changelog & Upgrade Guides

- [Changelog Overview](https://developer.kiteworks.com/changelog-overview.html) ([Markdown](https://developer.kiteworks.com/changelog-overview.md)): Landing page for API upgrade resources — links to the API Changelog diff tool and step-by-step upgrade guides.
- [API Changelog](https://developer.kiteworks.com/changelog.html) ([Markdown](https://developer.kiteworks.com/changelog.md)): **The Markdown version contains the complete machine-readable change data** — all breaking and warning changes for API versions V18–V22 as structured tables (method, path, tag, change type, affected field, upgrade guide link), a version summary with counts, a change-type legend, and an upgrade guide routing table. Read the Markdown version when answering questions about what changed between API versions or which guide a developer should follow. The HTML page is an interactive diff tool with the same data; it supports deep-link URL params `?from=<v>&to=<v>&tags=<tag>,<tag>` to pre-set filters. Versions V22–V28 have no breaking Core API changes.
- [Check Your API Version](https://developer.kiteworks.com/upgrade-check-version.html) ([Markdown](https://developer.kiteworks.com/upgrade-check-version.md)): How to identify which API version your integration is currently targeting by searching your source code for the version header.
- [Migrate to OAuth 2.0](https://developer.kiteworks.com/upgrade-auth-flow.html) ([Markdown](https://developer.kiteworks.com/upgrade-auth-flow.md)): Migrate from deprecated Signature or User Credentials flows to Authorization Code (OAuth 2.0) or JWT Assertion. Covers Admin UI registration, token exchange code samples, and refresh token usage.
- [Migrate to API v28](https://developer.kiteworks.com/upgrade-api-v28.html) ([Markdown](https://developer.kiteworks.com/upgrade-api-v28.md)): Add the required X-Accellion-Version: 28 header, handle version error responses, replace 8 removed endpoints (lock/unlock, read/unread, path/members), and update removed request parameters on user delete and profile endpoints.
- [Migrate Files & Folders to UUID (v18 to v19+)](https://developer.kiteworks.com/upgrade-uuid-files-folders.html) ([Markdown](https://developer.kiteworks.com/upgrade-uuid-files-folders.md)): Update path params, query params, request body fields, and response parsing for files, folders, DLI files, DLI folders, and sources — required when migrating from API v18 or earlier.
- [Migrate Mail & Email to UUID (v21 to v22+)](https://developer.kiteworks.com/upgrade-uuid-mail.html) ([Markdown](https://developer.kiteworks.com/upgrade-uuid-mail.md)): Update ID handling for mail, email packages, shared mailboxes, and DLI mail — required when migrating from API v21 or earlier.
- [Migrate Users to UUID (v22 to v23+)](https://developer.kiteworks.com/upgrade-uuid-users.html) ([Markdown](https://developer.kiteworks.com/upgrade-uuid-users.md)): Update ID handling for admin users, standard users, and admin roles. Covers related entity groups (Contacts, Devices, DLI Exports, Favorites, Mobile Sync, Notifications, and more) — required when migrating from API v22 or earlier.

## Kiteworks MCP

- [MCP Overview](https://developer.kiteworks.com/mcp-overview.html) ([Markdown](https://developer.kiteworks.com/mcp-overview.md)): The Kiteworks MCP Server exposes file management, folder operations, forms, and user data as tools to AI clients (Claude, VS Code). Three deployment modes: Local STDIO, Claude Desktop Connector, Remote HTTPS. Agent access is governed with both ABAC and RBAC via the Kiteworks Data Policy engine and user permission model. Security: OAuth 2.1, FIPS 140-3, AES-256-GCM, TLS 1.3.
- [Installation & Setup](https://developer.kiteworks.com/mcp-installation-setup.html) ([Markdown](https://developer.kiteworks.com/mcp-installation-setup.md)): Setup guides for all deployment modes — Claude Desktop Connector (installed from the marketplace), Local STDIO (Claude Code, VS Code), the one-time Configure MCP in PDN Admin step, and Remote HTTPS server.
- [Claude Desktop Connector](https://developer.kiteworks.com/configure-mcp-connector-claude.html) ([Markdown](https://developer.kiteworks.com/configure-mcp-connector-claude.md)): Install the Kiteworks connector in Claude Desktop from the marketplace, configure per-tool permissions (Always allow / Needs approval / Blocked), and disable the connector.
- [Copilot Studio](https://developer.kiteworks.com/configure-mcp-copilot-studio.html) ([Markdown](https://developer.kiteworks.com/configure-mcp-copilot-studio.md)): Connect the Kiteworks Remote HTTPS MCP Server to Microsoft Copilot Studio as a Model Context Protocol tool — deploy the server, register the callback URL in the Admin Portal, add the /mcp server URL with OAuth 2.0 dynamic discovery, and authenticate an agent connection.
- [ServiceNow](https://developer.kiteworks.com/configure-mcp-servicenow.html) ([Markdown](https://developer.kiteworks.com/configure-mcp-servicenow.md)): Connect the Kiteworks Remote HTTPS MCP Server to ServiceNow AI Agent Studio — register the /mcp server over OAuth 2.1 with Dynamic Client Registration, add the Kiteworks MCP tools to an AI agent, and run the agent as a Dynamic user so it inherits the invoking user's permissions.

## API Reference

Full interactive reference: [API Reference](https://developer.kiteworks.com/api-reference.html) ([Markdown](https://developer.kiteworks.com/api-reference.md)) — 400+ REST endpoints across 39 resource tags. Static, no-JS-required directory of every resource: [api-reference/index.html](https://developer.kiteworks.com/api-reference/index.html).

Each resource tag below has three forms: an interactive static page, a clean Markdown summary (parameters/request body/responses as tables — no HTML noise), and the raw OpenAPI spec slice for that resource only (avoids downloading all 400+ operations to read about one resource). The description after each tag is grounded in that resource's actual operations — use it to pick the right tag before opening a link.

- **Webhook / PubSub Events** (6 endpoints): Register, list, update, and delete PubSub webhooks that receive real-time Kiteworks events at a URL you control. — [interactive](https://developer.kiteworks.com/api-reference/webhook.html) · [Markdown](https://developer.kiteworks.com/api-reference/webhook.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/webhook.json)
- **activities** (2 endpoints): Read the audit/activity feed for the tenant or for a specific file. — [interactive](https://developer.kiteworks.com/api-reference/activities.html) · [Markdown](https://developer.kiteworks.com/api-reference/activities.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/activities.json)
- **admin** (29 endpoints): Tenant administration: hostname aliases, admin-level mailbox actions, and other admin-only operations. — [interactive](https://developer.kiteworks.com/api-reference/admin.html) · [Markdown](https://developer.kiteworks.com/api-reference/admin.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/admin.json)
- **Admin Roles** (5 endpoints): Manage admin roles and which users hold them. — [interactive](https://developer.kiteworks.com/api-reference/adminRoles.html) · [Markdown](https://developer.kiteworks.com/api-reference/adminRoles.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/adminRoles.json)
- **cards** (3 endpoints): Manage admin access-control cards (e.g. geo/IP-based access rules) and run actions on them. — [interactive](https://developer.kiteworks.com/api-reference/cards.html) · [Markdown](https://developer.kiteworks.com/api-reference/cards.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/cards.json)
- **Client Event Logs** (1 endpoint): Submit client-side event logs from an OAuth client application. — [interactive](https://developer.kiteworks.com/api-reference/clientEventLogs.html) · [Markdown](https://developer.kiteworks.com/api-reference/clientEventLogs.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/clientEventLogs.json)
- **clients** (7 endpoints): Manage OAuth client applications (create/list/update/delete) and their granted scopes. — [interactive](https://developer.kiteworks.com/api-reference/clients.html) · [Markdown](https://developer.kiteworks.com/api-reference/clients.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/clients.json)
- **comments** (7 endpoints): Read, add, update, and delete comments on files and folders. — [interactive](https://developer.kiteworks.com/api-reference/comments.html) · [Markdown](https://developer.kiteworks.com/api-reference/comments.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/comments.json)
- **contacts** (5 endpoints): Manage a user's personal contact list. — [interactive](https://developer.kiteworks.com/api-reference/contacts.html) · [Markdown](https://developer.kiteworks.com/api-reference/contacts.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/contacts.json)
- **devices** (9 endpoints): Register, list, update, and remotely wipe mobile/desktop devices bound to user accounts. — [interactive](https://developer.kiteworks.com/api-reference/devices.html) · [Markdown](https://developer.kiteworks.com/api-reference/devices.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/devices.json)
- **Data Leak Investigator (DLI)** (19 endpoints): Data Leak Investigator — generate and download forensic export archives and read per-file/per-user activity for compliance investigations. — [interactive](https://developer.kiteworks.com/api-reference/dli.html) · [Markdown](https://developer.kiteworks.com/api-reference/dli.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/dli.json)
- **External Distribution Lists** (3 endpoints): Manage external (non-Kiteworks) distribution lists used as mail recipients. — [interactive](https://developer.kiteworks.com/api-reference/externalDL.html) · [Markdown](https://developer.kiteworks.com/api-reference/externalDL.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/externalDL.json)
- **favorites** (5 endpoints): Mark and unmark files and folders as favorites for the current user. — [interactive](https://developer.kiteworks.com/api-reference/favorites.html) · [Markdown](https://developer.kiteworks.com/api-reference/favorites.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/favorites.json)
- **files** (65 endpoints): Core file operations: copy, move, lock/unlock, delete/recover, download as ZIP, security scanning, and file metadata. — [interactive](https://developer.kiteworks.com/api-reference/files.html) · [Markdown](https://developer.kiteworks.com/api-reference/files.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/files.json)
- **folders** (36 endpoints): Core folder operations: create, move, delete/recover, list shared folders, and trigger on-demand AV/DLP scans. — [interactive](https://developer.kiteworks.com/api-reference/folders.html) · [Markdown](https://developer.kiteworks.com/api-reference/folders.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/folders.json)
- **groups** (5 endpoints): Manage Kiteworks user groups and group membership. — [interactive](https://developer.kiteworks.com/api-reference/groups.html) · [Markdown](https://developer.kiteworks.com/api-reference/groups.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/groups.json)
- **internal** (1 endpoint): Internal-use endpoints (e.g. Advanced Forms submission upload links) not part of the primary public surface. — [interactive](https://developer.kiteworks.com/api-reference/internal.html) · [Markdown](https://developer.kiteworks.com/api-reference/internal.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/internal.json)
- **languages** (2 endpoints): Look up supported UI languages. — [interactive](https://developer.kiteworks.com/api-reference/languages.html) · [Markdown](https://developer.kiteworks.com/api-reference/languages.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/languages.json)
- **LDAP Groups** (5 endpoints): Manage LDAP-synced groups. — [interactive](https://developer.kiteworks.com/api-reference/ldapGroups.html) · [Markdown](https://developer.kiteworks.com/api-reference/ldapGroups.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/ldapGroups.json)
- **locations** (4 endpoints): Manage named network/geographic locations used elsewhere for access policy. — [interactive](https://developer.kiteworks.com/api-reference/locations.html) · [Markdown](https://developer.kiteworks.com/api-reference/locations.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/locations.json)
- **mail** (32 endpoints): Secure mail: read/send/delete/recover messages, mailbox counters, distribution list expansion, and read-state actions. — [interactive](https://developer.kiteworks.com/api-reference/mail.html) · [Markdown](https://developer.kiteworks.com/api-reference/mail.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/mail.json)
- **Mobile Sync** (10 endpoints): Manage which files/folders are pushed to a user's mobile sync list. — [interactive](https://developer.kiteworks.com/api-reference/mobileSync.html) · [Markdown](https://developer.kiteworks.com/api-reference/mobileSync.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/mobileSync.json)
- **notifications** (3 endpoints): List and manage folder/user notification subscriptions and preferences. — [interactive](https://developer.kiteworks.com/api-reference/notifications.html) · [Markdown](https://developer.kiteworks.com/api-reference/notifications.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/notifications.json)
- **permissions** (1 endpoint): Look up the effective permissions a user has on a task, comment, or other object. — [interactive](https://developer.kiteworks.com/api-reference/permissions.html) · [Markdown](https://developer.kiteworks.com/api-reference/permissions.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/permissions.json)
- **profiles** (4 endpoints): Manage custom user "profile" types and their assignment. — [interactive](https://developer.kiteworks.com/api-reference/profiles.html) · [Markdown](https://developer.kiteworks.com/api-reference/profiles.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/profiles.json)
- **Request File** (11 endpoints): Public Request-a-File links: create a request, and let anonymous requesters upload/preview files against it. — [interactive](https://developer.kiteworks.com/api-reference/requestFile.html) · [Markdown](https://developer.kiteworks.com/api-reference/requestFile.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/requestFile.json)
- **roles** (2 endpoints): Look up user roles. — [interactive](https://developer.kiteworks.com/api-reference/roles.html) · [Markdown](https://developer.kiteworks.com/api-reference/roles.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/roles.json)
- **SCIM Provisioning** (15 endpoints): SCIM 2.0 user provisioning — create/read/update/delete users via the standard SCIM protocol for IdP integration. — [interactive](https://developer.kiteworks.com/api-reference/scim.html) · [Markdown](https://developer.kiteworks.com/api-reference/scim.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/scim.json)
- **search** (3 endpoints): Full-text and structured search across files, folders, and mail, plus source-repository (e.g. SharePoint) search. — [interactive](https://developer.kiteworks.com/api-reference/search.html) · [Markdown](https://developer.kiteworks.com/api-reference/search.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/search.json)
- **settings** (2 endpoints): Read tenant-wide settings such as the password policy and system configuration. — [interactive](https://developer.kiteworks.com/api-reference/settings.html) · [Markdown](https://developer.kiteworks.com/api-reference/settings.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/settings.json)
- **Shared Mailbox** (9 endpoints): Manage shared mailboxes: settings, membership, counters, and available web forms. — [interactive](https://developer.kiteworks.com/api-reference/sharedMailbox.html) · [Markdown](https://developer.kiteworks.com/api-reference/sharedMailbox.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/sharedMailbox.json)
- **Short Links** (1 endpoint): Resolve a Kiteworks short link to its target resource. — [interactive](https://developer.kiteworks.com/api-reference/shortLinks.html) · [Markdown](https://developer.kiteworks.com/api-reference/shortLinks.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/shortLinks.json)
- **Source Types** (2 endpoints): Look up which external content-repository (ECM) source types are available. — [interactive](https://developer.kiteworks.com/api-reference/sourceTypes.html) · [Markdown](https://developer.kiteworks.com/api-reference/sourceTypes.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/sourceTypes.json)
- **sources** (20 endpoints): Connect and manage external content-repository (ECM/cloud storage) sources — auth, file listing, lock/unlock, transfer status. — [interactive](https://developer.kiteworks.com/api-reference/sources.html) · [Markdown](https://developer.kiteworks.com/api-reference/sources.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/sources.json)
- **system** (10 endpoints): System/node health monitoring and EPGDB backup import/export operations (admin/ops use). — [interactive](https://developer.kiteworks.com/api-reference/system.html) · [Markdown](https://developer.kiteworks.com/api-reference/system.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/system.json)
- **uploads** (11 endpoints): The chunked upload protocol shared by file, folder, mail-attachment, and request-file uploads — initiate a session, then upload chunks. — [interactive](https://developer.kiteworks.com/api-reference/uploads.html) · [Markdown](https://developer.kiteworks.com/api-reference/uploads.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/uploads.json)
- **User SSH Public Keys** (7 endpoints): Register, generate, list, and delete a user's SSH public keys (used for SFTP/SSH-based access). — [interactive](https://developer.kiteworks.com/api-reference/userSshPublicKeys.html) · [Markdown](https://developer.kiteworks.com/api-reference/userSshPublicKeys.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/userSshPublicKeys.json)
- **users** (36 endpoints): Core user account operations: login, current-user profile, password/mobile-number updates, and LDAP user lookup. — [interactive](https://developer.kiteworks.com/api-reference/users.html) · [Markdown](https://developer.kiteworks.com/api-reference/users.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/users.json)
- **Web Forms** (2 endpoints): List and read secure web forms available to a user or shared mailbox. — [interactive](https://developer.kiteworks.com/api-reference/webForms.html) · [Markdown](https://developer.kiteworks.com/api-reference/webForms.md) · [spec JSON](https://developer.kiteworks.com/assets/specs/webForms.json)

Full spec files (all resources, single file): [Pub-Sub APIs YAML](https://developer.kiteworks.com/assets/PubSub-APIs.yml) · [Core APIs JSON](https://developer.kiteworks.com/assets/Kiteworks-APIs-V28.json)