Kiteworks Core API

{
    "openapi": "3.0.2",
    "info": {
        "version": "28",
        "title": "Kiteworks API Documentation"
    },
    "paths": {
        "/rest/activities": {
            "get": {
                "tags": [
                    "activities"
                ],
                "summary": "Get all activities",
                "description": "Returns the activity log for the authenticated user across all files and folders they have access to.",
                "responses": {
                    "200": {
                        "description": "Returns a list of activity records for the authenticated user.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Activity"
                                            }
                                        }
                                    }
                                },
                                "examples": {
                                    "User activity list": {
                                        "summary": "Recent activities for the authenticated user",
                                        "value": [
                                            {
                                                "id": 1002,
                                                "event": "upload",
                                                "message": "User uploaded budget-2024.xlsx",
                                                "type": "f",
                                                "created": "2024-03-16T08:00:00+00:00",
                                                "successful": 1,
                                                "user": {
                                                    "id": 5,
                                                    "name": "Jane Smith"
                                                },
                                                "data": {
                                                    "file": {
                                                        "id": 8,
                                                        "name": "budget-2024.xlsx"
                                                    }
                                                }
                                            },
                                            {
                                                "id": 1001,
                                                "event": "download",
                                                "message": "User downloaded quarterly-report.pdf",
                                                "type": "f",
                                                "created": "2024-03-15T10:30:00+00:00",
                                                "successful": 1,
                                                "user": {
                                                    "id": 5,
                                                    "name": "Jane Smith"
                                                },
                                                "data": {
                                                    "file": {
                                                        "id": 7,
                                                        "name": "quarterly-report.pdf"
                                                    }
                                                }
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "490": {
                        "description": "Request blocked by WAF"
                    }
                },
                "deprecated": false,
                "parameters": [
                    {
                        "in": "query",
                        "name": "noDayBack",
                        "description": "Number of days back to search",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "startDate",
                        "description": "Start date",
                        "schema": {
                            "type": "string",
                            "format": "date"
                        }
                    },
                    {
                        "in": "query",
                        "name": "endDate",
                        "description": "End date",
                        "schema": {
                            "type": "string",
                            "format": "date"
                        }
                    },
                    {
                        "in": "query",
                        "name": "filter",
                        "description": "Filter activities by scope. Accepted values: `all`, `my`.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "all",
                                "my"
                            ]
                        }
                    },
                    {
                        "in": "query",
                        "name": "search",
                        "description": "Search by mail body, subject and sender/recipients",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "type",
                        "description": "Filter activities by type. Accepted values: `all`, `folder_changes`, `file_changes`, `user_preferences`, `mail`, `tasks`, `comments`, `kitepoint`.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "all",
                                "folder_changes",
                                "file_changes",
                                "user_preferences",
                                "mail",
                                "tasks",
                                "comments",
                                "kitepoint"
                            ]
                        }
                    },
                    {
                        "in": "query",
                        "name": "transactionId",
                        "description": "Transaction ID associated with the activities",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "orderBy",
                        "description": "Sorting options",
                        "schema": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            },
                            "enum": [
                                "created:asc",
                                "created:desc",
                                "name:asc",
                                "name:desc"
                            ]
                        }
                    },
                    {
                        "in": "query",
                        "name": "offset",
                        "description": "Offset",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "limit",
                        "description": "Limit",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "with",
                        "description": "With parameters",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "mode",
                        "description": "Determines the detail level of the response body.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "full_with_links",
                                "full",
                                "compact"
                            ]
                        }
                    }
                ]
            }
        },
        "/rest/admin/hostnames": {
            "get": {
                "tags": [
                    "admin"
                ],
                "summary": "List hostnames",
                "description": "Returns a paginated list of all alias hostnames, including their hostname, disabled state, and deletion status.",
                "responses": {
                    "200": {
                        "description": "List of hostnames retrieved successfully.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Hostname"
                                            }
                                        },
                                        "metadata": {
                                            "$ref": "#/components/schemas/MetaData"
                                        }
                                    }
                                },
                                "examples": {
                                    "HostnameList": {
                                        "summary": "Paginated list of hostnames",
                                        "value": {
                                            "data": [
                                                {
                                                    "id": 1,
                                                    "hostname": "alias.example.com",
                                                    "deleted": false,
                                                    "disabled": false
                                                }
                                            ],
                                            "metadata": {
                                                "total": 1,
                                                "limit": 50,
                                                "offset": 0
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "490": {
                        "description": "Request blocked by WAF"
                    }
                },
                "deprecated": false,
                "parameters": [
                    {
                        "in": "query",
                        "name": "alias_name",
                        "description": "Alias name",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "alias_name:contains",
                        "description": "Alias name. Search for results that contain the specified characters in this parameter.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "tenant_id",
                        "description": "Tenant ID",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "tenant_id:gt",
                        "description": "Tenant ID. Search for results where this parameter value is greater than the specified value.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "tenant_id:gte",
                        "description": "Tenant ID. Search for results where this parameter value is greater than or equal to the specified value.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "tenant_id:lt",
                        "description": "Tenant ID. Search for results where this parameter value is less than the specified value.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "tenant_id:lte",
                        "description": "Tenant ID. Search for results where this parameter value is less than or equal to the specified value.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "deleted",
                        "description": "Filter by whether the hostname is deleted.",
                        "schema": {
                            "type": "boolean"
                        }
                    },
                    {
                        "in": "query",
                        "name": "disabled",
                        "description": "Filter by whether the hostname is disabled.",
                        "schema": {
                            "type": "boolean"
                        }
                    },
                    {
                        "in": "query",
                        "name": "orderBy",
                        "description": "Sorting options",
                        "schema": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            },
                            "enum": [
                                "id:asc",
                                "id:desc",
                                "alias_name:asc",
                                "alias_name:desc",
                                "tenant_id:asc",
                                "tenant_id:desc",
                                "deleted:asc",
                                "deleted:desc",
                                "disabled:asc",
                                "disabled:desc"
                            ]
                        }
                    },
                    {
                        "in": "query",
                        "name": "offset",
                        "description": "Offset",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "limit",
                        "description": "Limit",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "in": "query",
                        "name": "with",
                        "description": "With parameters",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "mode",
                        "description": "Determines the detail level of the response body.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "full_with_links",
                                "full",
                                "compact"
                            ]
                        }
                    }
                ]
            },
            "delete": {
                "tags": [
                    "admin"
                ],
                "summary": "Deletes list of hostnames",
                "description": "Soft-deletes a list of hostnames in a single request. Supports partial success, meaning valid items are processed even if some fail.",
                "responses": {
                    "204": {
                        "description": "Hostnames deleted successfully."
                    },
                    "403": {
                        "description": "Forbidden<br /><br /><i>Possible error codes: </i>ERR_ACCESS_USER",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Errors"
                                },
                                "examples": {
                                    "ERR_ACCESS_USER": {
                                        "summary": "Insufficient access permissions",
                                        "description": "Insufficient access permissions",
                                        "value": {
                                            "errors": {
                                                "code": "ERR_ACCESS_USER",
                                                "message": "Insufficient access permissions"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "490": {
                        "description": "Request blocked by WAF"
                    }
                },
                "deprecated": false,
                "parameters": [
                    {
                        "in": "query",
                        "name": "id:in",
                        "description": "A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "in": "query",
                        "name": "partialSuccess",
                        "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure.",
                        "schema": {
                            "type": "boolean"
                        }
                    },
                    {
                        "in": "query",
                        "name": "mode",
                        "description": "Determines the detail level of the response body.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "full_with_links",
                                "full"
                            ]
                        }
                    }
                ]
            },
            "post": {
                "tags": [
                    "admin"
                ],
                "summary": "Create an alias hostname",
                "description": "Creates a new alias hostname for the current tenant. The hostname must be a valid subdomain of the configured site domain and must not already exist.",
                "responses": {
                    "200": {
                        "description": "Hostname created successfully.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Hostname"
                                },
                                "examples": {
                                    "HostnameCreated": {
                                        "summary": "A newly created hostname",
                                        "value": {
                                            "id": 2,
                                            "hostname": "newteam.example.com",
                                            "deleted": false,
                                            "disabled": false
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "409": {
                        "description": "Conflict<br /><br /><i>Possible error codes: </i>ERR_ENTITY_EXISTS",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Errors"
                                },
                                "examples": {
                                    "ERR_ENTITY_EXISTS": {
                                        "summary": "Entity exists",
                                        "description": "Entity exists",
                                        "value": {
                                            "errors": {
                                                "code": "ERR_ENTITY_EXISTS",
                                                "message": "Entity exists"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "Unprocessable Content<br /><br /><i>Possible error codes: </i>ERR_INPUT_REQUIRED, ERR_INPUT_NOT_BOOLEAN",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Errors"
                                },
                                "examples": {
                                    "ERR_INPUT_REQUIRED": {
                                        "summary": "Field is required",
                                        "description": "Field is required",
                                        "value": {
                                            "errors": {
                                                "code": "ERR_INPUT_REQUIRED",
                                                "message": "Field is required"
                                            }
                                        }
                                    },
                                    "ERR_INPUT_NOT_BOOLEAN": {
                                        "summary": "Input is not a valid boolean",
                                        "description": "Input is not a valid boolean",
                                        "value": {
                                            "errors": {
                                                "code": "ERR_INPUT_NOT_BOOLEAN",
                                                "message": "Input is not a valid boolean"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "490": {
                        "description": "Request blocked by WAF"
                    }
                },
                "deprecated": false,
                "parameters": [
                    {
                        "in": "query",
                        "name": "returnEntity",
                        "description": "If set to `true`, returns information about the newly created entity.",
                        "schema": {
                            "type": "boolean"
                        }
                    },
                    {
                        "in": "query",
                        "name": "mode",
                        "description": "Determines the detail level of the response body.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "full_with_links",
                                "full"
                            ]
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Hostname.Post"
                            }
                        }
                    }
                }
            }
        },
        "/rest/admin/hostnames/{id}": {
            "get": {
                "tags": [
                    "admin"
                ],
                "summary": "Returns the details of hostname of the specified ID.",
                "description": "Returns the hostname record identified by the given ID, including its hostname value, disabled state, and deletion status.",
                "responses": {
                    "200": {
                        "description": "Hostname details retrieved successfully.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Hostname"
                                },
                                "examples": {
                                    "HostnameInfo": {
                                        "summary": "Details of a single hostname record",
                                        "value": {
                                            "id": 1,
                                            "hostname": "alias.example.com",
                                            "deleted": false,
                                            "disabled": false
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "490": {
                        "description": "Request blocked by WAF"
                    }
                },
                "deprecated": false,
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "ID of the hostname to be retrieved",
                        "required": true,
                        "schema": {
                            "type": "integer"
                        }
                    }
                ]
            },
            "put": {
                "tags": [
                    "admin"
                ],
                "summary": "Disable / enable alias hostname",
                "description": "Updates the disabled state of the specified hostname, allowing it to be enabled or disabled.",
                "responses": {
                    "200": {
                        "description": "Hostname updated successfully.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Hostname"
                                },
                                "examples": {
                                    "HostnameDisabled": {
                                        "summary": "Hostname after being disabled",
                                        "value": {
                                            "id": 1,
                                            "hostname": "alias.example.com",
                                            "deleted": false,
                                            "disabled": true
                                        }
                                    },
                                    "HostnameEnabled": {
                                        "summary": "Hostname after being re-enabled",
                                        "value": {
                                            "id": 1,
                                            "hostname": "alias.example.com",
                                            "deleted": false,
                                            "disabled": false
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "Forbidden<br /><br /><i>Possible error codes: </i>ERR_ACCESS_USER",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Errors"
                                },
                                "examples": {
                                    "ERR_ACCESS_USER": {
                                        "summary": "Insufficient access permissions",
                                        "description": "Insufficient access permissions",
                                        "value": {
                                            "errors": {
                                                "code": "ERR_ACCESS_USER",
                                                "message": "Insufficient access permissions"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "490": {
                        "description": "Request blocked by WAF"
                    }
                },
                "deprecated": false,
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "ID of the hostname to disable",
                        "required": true,
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Hostname.Put"
                            }
                        }
                    }
                }
            },
            "delete": {
                "tags": [
                    "admin"
                ],
                "summary": "Mark specified hostname as deleted.",
                "description": "Soft-deletes the specified hostname by marking it as deleted. The record is retained but treated as inactive.",
                "responses": {
                    "204": {
                        "description": "H

# --- truncated at 32 KB (3414 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kiteworks/refs/heads/main/openapi/kiteworks-core-openapi-original.json