Skip to content

About

A simple PHP SDK for integrating with the ONLYOFFICE DocSpace API

Topics

docspaceintegrationonlyofficesdk

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository
BranchesTags

Repository files navigation

onlyoffice/docspace-api-sdk

The ONLYOFFICE DocSpace SDK for PHP is a library that provides tools for integrating and managing DocSpace features within your applications. It simplifies interaction with the DocSpace API by offering ready-to-use methods and models.

For more information, please visit https://helpdesk.onlyoffice.com/hc/en-us.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/ONLYOFFICE/docspace-api-sdk-php"
    }
  ],
  "require": {
    "onlyoffice/docspace-api-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/onlyoffice/docspace-api-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: cookieAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('asc_auth_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('asc_auth_key', 'Bearer');

// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new OpenAPI\Client\Api\AIAIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ai_approve_tool_call_request = new \OpenAPI\Client\Model\AiApproveToolCallRequest(); // \OpenAPI\Client\Model\AiApproveToolCallRequest

try {
    $result = $apiInstance->aiApproveToolCall($ai_approve_tool_call_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AIAIApi->aiApproveToolCall: ', $e->getMessage(), PHP_EOL;
}

Authorization

Authentication schemes defined for the API:

cookieAuth

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location: Cookie

bearerAuth

  • Type: Bearer authentication

asc_auth_key

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location: Cookie

Basic

  • Type: HTTP basic authentication

Bearer

  • Type: Bearer authentication (JWT)

ApiKeyBearer

  • Type: API key
  • API key parameter name: ApiKeyBearer
  • Location: HTTP header

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: {{authBaseUrl}}/oauth2/authorize
  • Token Url: {{authBaseUrl}}/oauth2/token
  • Scopes:
    • read: Read access to protected resources
    • write: Write access to protected resources

OpenId

  • Type: OpenId Connect
  • OpenId Connect URL: {{authBaseUrl}}/.well-known/openid-configuration

x-signature

  • Type: API key
  • API key parameter name: x-signature
  • Location: Cookie

Rate Limiting

All API responses may include the following rate limiting headers:

Header Description
X-RateLimit-Limit Sliding window rate limit: 1500 requests per minute per user/IP.
X-RateLimit-Remaining Number of requests remaining in the current sliding window (1500 req/min). Concurrent limits also apply: 50 parallel GET requests, 15 parallel POST/PUT requests.
X-RateLimit-Reset Unix timestamp (seconds) when the current sliding window rate limit resets.
Retry-After Seconds to wait before retrying. Up to 60s for the sliding window (1500 req/min), up to 86400s for the daily POST/PUT limit (10000/day).

API Endpoints

All URIs are relative to https://your-docspace.onlyoffice.com

API Endoints tables:

AI
Method HTTP request Description
AIApi
aiApproveToolCall POST /api/2.0/ai/ai/approve-tool-call Approve tool call
aiDenyToolCall POST /api/2.0/ai/ai/deny-tool-call Deny tool call
aiRegenerateStream POST /api/2.0/ai/ai/regenerate-stream Regenerate stream
aiSend POST /api/2.0/ai/ai/send Run an AI action
aiSendCustom POST /api/2.0/ai/ai/send-custom Send custom
aiSendWithStream POST /api/2.0/ai/ai/send-with-stream Send with stream
aiSendWithStreamOpenAI POST /api/2.0/ai/ai/send-with-stream-openai Stream a chat in OpenAI format
AgentsApi
aiAgentsCreate POST /api/2.0/ai/agents Create an agent
aiAgentsDelete DELETE /api/2.0/ai/agents/{id} Delete an agent
aiAgentsGet GET /api/2.0/ai/agents/{id} Get an agent
aiAgentsList GET /api/2.0/ai/agents List agents
aiAgentsNews GET /api/2.0/ai/agents/news List agent news items
aiAgentsResetQuota PUT /api/2.0/ai/agents/resetquota Reset agents' quota
aiAgentsUpdate PUT /api/2.0/ai/agents/{id} Update an agent
aiAgentsUpdateQuota PUT /api/2.0/ai/agents/agentquota Update agents' quota
AssignmentsApi
aiAssignmentsAssign PUT /api/2.0/ai/assignments/assign Bind a profile to an action
aiAssignmentsBulkAssign PUT /api/2.0/ai/assignments/bulk-assign Bulk assign
aiAssignmentsCascadeProfileDelete DELETE /api/2.0/ai/assignments/cascade-profile-delete Cascade profile delete
aiAssignmentsGetAllAssignments GET /api/2.0/ai/assignments/get-all-assignments Get all assignments
aiAssignmentsGetAssignment GET /api/2.0/ai/assignments/get-assignment Get assignment
aiAssignmentsResolveForAction GET /api/2.0/ai/assignments/resolve-for-action Resolve for action
aiAssignmentsTryResolveForAction GET /api/2.0/ai/assignments/try-resolve-for-action Try resolve for action
aiAssignmentsUnassign DELETE /api/2.0/ai/assignments/unassign Clear an action's profile
AttachmentsApi
aiAttachmentsDelete DELETE /api/2.0/ai/attachments/delete Delete one attachment
aiAttachmentsDeleteMany DELETE /api/2.0/ai/attachments/delete-many Delete many
aiAttachmentsGet POST /api/2.0/ai/attachments/get Get one attachment
aiAttachmentsGetMany POST /api/2.0/ai/attachments/get-many Get many
aiAttachmentsGetSuggestedQuestions POST /api/2.0/ai/attachments/suggested-questions Get suggested questions
aiAttachmentsLinkToMessage POST /api/2.0/ai/attachments/link-to-message Link to message
aiAttachmentsSaveFile POST /api/2.0/ai/attachments/save-file Save file
aiAttachmentsSaveFilesMany POST /api/2.0/ai/attachments/save-files-many Save files many
ContextApi
aiContextGetContextFolders GET /api/2.0/ai/context/get-context-folders Get context folders
aiContextGetRoomSkill GET /api/2.0/ai/context/get-room-skill Get room skill
aiContextGetRoomSkills GET /api/2.0/ai/context/get-room-skills Get room skills
EditorToolsApi
aiEditorToolsCall POST /api/2.0/ai/editor-tools/call Call an editor tool
aiEditorToolsList GET /api/2.0/ai/editor-tools/list List editor tools
ExportApi
aiExportTextToDocx POST /api/2.0/ai/text-to-docx Start markdown export
OpenAIPassthroughApi
aiOpenaiChatCompletions POST /api/2.0/ai/openai/{profileId}/v1/chat/completions OpenAI chat completions passthrough
aiOpenaiImagesGenerations POST /api/2.0/ai/openai/{profileId}/v1/images/generations OpenAI image generation passthrough
PreferencesApi
aiPreferencesClearDeepMode DELETE /api/2.0/ai/preferences/clear-deep-mode Clear deep mode
aiPreferencesGetDeepMode GET /api/2.0/ai/preferences/get-deep-mode Get deep mode
aiPreferencesGetReasoningLevel GET /api/2.0/ai/preferences/get-reasoning-level Get reasoning level
aiPreferencesGetToolPermissionMode GET /api/2.0/ai/preferences/get-tool-permission-mode Get tool permission mode
aiPreferencesIsDeepModeSet GET /api/2.0/ai/preferences/is-deep-mode-set Is deep mode set
aiPreferencesSetDeepMode PUT /api/2.0/ai/preferences/set-deep-mode Set deep mode
aiPreferencesSetReasoningLevel PUT /api/2.0/ai/preferences/set-reasoning-level Set reasoning level
aiPreferencesSetToolPermissionMode PUT /api/2.0/ai/preferences/set-tool-permission-mode Set tool permission mode
ProfilesApi
aiProfilesCreate POST /api/2.0/ai/profiles/create Create a provider profile
aiProfilesDelete DELETE /api/2.0/ai/profiles/delete Delete a provider profile
aiProfilesGetById GET /api/2.0/ai/profiles/get-by-id Get a provider profile
aiProfilesList GET /api/2.0/ai/profiles/list List provider profiles
aiProfilesListModels GET /api/2.0/ai/profiles/list-models List models
aiProfilesListProviderModels POST /api/2.0/ai/profiles/list-provider-models List provider models
aiProfilesTestConnection POST /api/2.0/ai/profiles/test-connection Test a profile's provider
aiProfilesUpdate PUT /api/2.0/ai/profiles/update Update a provider profile
PromptsApi
aiPromptsCreate POST /api/2.0/ai/prompts/create Save a prompt
aiPromptsCreateFolder POST /api/2.0/ai/prompts/create-folder Create folder
aiPromptsDelete DELETE /api/2.0/ai/prompts/delete Delete a saved prompt
aiPromptsDeleteFolder DELETE /api/2.0/ai/prompts/delete-folder Delete folder
aiPromptsExport GET /api/2.0/ai/prompts/export Export the prompt library
aiPromptsGetById GET /api/2.0/ai/prompts/get-by-id Get a saved prompt
aiPromptsGetFolderById GET /api/2.0/ai/prompts/get-folder-by-id Get a prompt folder
aiPromptsImportBundle POST /api/2.0/ai/prompts/import-bundle Import bundle
aiPromptsList GET /api/2.0/ai/prompts/list List saved prompts
aiPromptsListFolders GET /api/2.0/ai/prompts/list-folders List folders
aiPromptsMove PUT /api/2.0/ai/prompts/move Move a prompt to a folder
aiPromptsRenameFolder PUT /api/2.0/ai/prompts/rename-folder Rename folder
aiPromptsUpdate PUT /api/2.0/ai/prompts/update Update a saved prompt
SettingsApi
aiSettingsGet GET /api/2.0/ai/config Get AI settings
aiSettingsGetToolMode GET /api/2.0/ai/config/tool-mode Get the tool permission mode
aiSettingsGetUser GET /api/2.0/ai/config/user Get user AI settings
aiSettingsGetVectorization GET /api/2.0/ai/config/vectorization Get vectorization settings
aiSettingsSetToolMode PUT /api/2.0/ai/config/tool-mode Set the tool permission mode
aiSettingsSetUser PUT /api/2.0/ai/config/user Update user AI settings
aiSettingsSetVectorization PUT /api/2.0/ai/config/vectorization Update vectorization settings
ThreadsApi
aiThreadsAppendUserMessage POST /api/2.0/ai/threads/append-user-message Append user message
aiThreadsClearMessages DELETE /api/2.0/ai/threads/clear-messages Clear messages
aiThreadsCreate POST /api/2.0/ai/threads/create Create a chat thread
aiThreadsDelete DELETE /api/2.0/ai/threads/delete Delete a chat thread
aiThreadsDeleteMessage DELETE /api/2.0/ai/threads/delete-message Delete message
aiThreadsGetById GET /api/2.0/ai/threads/get-by-id Get a chat thread
aiThreadsGetMessageById GET /api/2.0/ai/threads/get-message-by-id Get one chat message
aiThreadsList GET /api/2.0/ai/threads/list List chat threads
aiThreadsOpenOrCreate POST /api/2.0/ai/threads/open-or-create Open or create
aiThreadsReadMessages GET /api/2.0/ai/threads/read-messages Read messages
aiThreadsRegenerateTitle POST /api/2.0/ai/threads/regenerate-title Regenerate title
aiThreadsRename PUT /api/2.0/ai/threads/rename Rename a chat thread
aiThreadsTouch POST /api/2.0/ai/threads/touch Bump a thread's activity
aiThreadsUpdateMessage PUT /api/2.0/ai/threads/update-message Update message
ToolsApi
aiToolsAddCustomServer POST /api/2.0/ai/tools/add-custom-server Add custom server
aiToolsGetAllowAlways GET /api/2.0/ai/tools/get-allow-always Get allow always
aiToolsGetCustomServer GET /api/2.0/ai/tools/get-custom-server Get custom server
aiToolsGetDisabled GET /api/2.0/ai/tools/get-disabled Get disabled
aiToolsIsAllowAlways GET /api/2.0/ai/tools/is-allow-always Is allow always
aiToolsIsToolDisabled GET /api/2.0/ai/tools/is-tool-disabled Is tool disabled
aiToolsListCustomServers GET /api/2.0/ai/tools/list-custom-servers List custom servers
aiToolsListSystemTools GET /api/2.0/ai/tools/list-system-tools List system tools
aiToolsRemoveCustomServer DELETE /api/2.0/ai/tools/remove-custom-server Remove custom server
aiToolsReplaceAllCustomServers PUT /api/2.0/ai/tools/replace-all-custom-servers Replace all custom servers
aiToolsSetAllowAlways PUT /api/2.0/ai/tools/set-allow-always Set allow always
aiToolsSetDisabled PUT /api/2.0/ai/tools/set-disabled Set disabled
aiToolsUpdateCustomServer PUT /api/2.0/ai/tools/update-custom-server Update custom server
VectorizationApi
aiVectorizationStartTask POST /api/2.0/ai/vectorization/tasks Start a vectorization task
WebSearchApi
aiWebSearchClear DELETE /api/2.0/ai/web-search/clear Clear the web-search configuration
aiWebSearchConfigure PUT /api/2.0/ai/web-search/configure Configure and verify web search
aiWebSearchGetActiveConfig GET /api/2.0/ai/web-search/get-active-config Get active config
aiWebSearchIsConfigured GET /api/2.0/ai/web-search/is-configured Is configured
aiWebSearchPassthroughContents POST /api/2.0/ai/websearch/v1/contents Web page contents passthrough
aiWebSearchPassthroughSearch POST /api/2.0/ai/websearch/v1/search Web search passthrough
aiWebSearchSetActiveConfig PUT /api/2.0/ai/web-search/set-active-config Set active config
aiWebSearchTestConnection POST /api/2.0/ai/web-search/test-connection Test a web-search provider
ApiKeys
Method HTTP request Description
ApiKeysApi
createApiKey POST /api/2.0/keys Create a user API key
deleteApiKey DELETE /api/2.0/keys/{keyId} Delete an API key
getAllPermissions GET /api/2.0/keys/permissions Get API key permissions
getApiKey GET /api/2.0/keys/@self Get the current API key
getApiKeys GET /api/2.0/keys Get the API keys
updateApiKey PUT /api/2.0/keys/{keyId} Update an API key
Apps
Method HTTP request Description
AppsApi
get GET /api/2.0/apps/{id} Get an app
getAll GET /api/2.0/apps Get all apps
getSettings GET /api/2.0/apps/{id}/settings Get app settings
setEnabled PUT /api/2.0/apps/{id}/enabled Enable or disable an app
setSettings PUT /api/2.0/apps/{id}/settings Save app settings
Authentication
Method HTTP request Description
AuthenticationApi
authenticateMe POST /api/2.0/authentication Authenticate a user
authenticateMeFromBodyWithCode POST /api/2.0/authentication/{code} Authenticate a user by code
checkConfirm POST /api/2.0/authentication/confirm Check a confirmation link
getIsAuthentificated GET /api/2.0/authentication Check authentication
logout POST /api/2.0/authentication/logout Log out
saveMobilePhone POST /api/2.0/authentication/setphone Set a mobile phone
sendSmsCode POST /api/2.0/authentication/sendsms Send SMS code
Backup
Method HTTP request Description
BackupApi
cancelBackup POST /api/2.0/backup/cancelbackup Cancel the running backup
createBackupSchedule POST /api/2.0/backup/createbackupschedule Create the backup schedule
deleteBackup DELETE /api/2.0/backup/deletebackup/{id} Delete the backup
deleteBackupHistory DELETE /api/2.0/backup/deletebackuphistory Delete the backup history
deleteBackupSchedule DELETE /api/2.0/backup/deletebackupschedule Delete the backup schedule
getBackupHistory GET /api/2.0/backup/getbackuphistory Get the backup history
getBackupProgress GET /api/2.0/backup/getbackupprogress Get the backup progress
getBackupSchedule GET /api/2.0/backup/getbackupschedule Get the backup schedule
getBackupsCount GET /api/2.0/backup/getbackupscount Get the number of backups
getBackupsCounts GET /api/2.0/backup/getbackupscountbypaid Get free and paid backup counts
getBackupsServiceState GET /api/2.0/backup/getservicestate Check whether backups are enabled
getRestoreProgress GET /api/2.0/backup/getrestoreprogress Get the restoring progress
startBackup POST /api/2.0/backup/startbackup Start the backup
startBackupRestore POST /api/2.0/backup/startrestore Start the restoring process
Capabilities
Method HTTP request Description
CapabilitiesApi
getPortalCapabilities GET /api/2.0/capabilities Get portal capabilities
Docs
Method HTTP request Description
DocsApi
convertFile POST /api/2.0/docs/converter Convert a file
runBuilderScript POST /api/2.0/docs/builder Run a document builder script
Files
Method HTTP request Description
FilesApi
addFileToRecent POST /api/2.0/files/file/{fileId}/recent Add a file to Recent
addTemplates POST /api/2.0/files/templates Add template files
changeVersionHistory PUT /api/2.0/files/file/{fileId}/history Change version history
checkFillFormDraft POST /api/2.0/files/masterform/{fileId}/checkfillformdraft Open a form draft for filling
copyFileAs POST /api/2.0/files/file/{fileId}/copyas Copy a file
createEditSession POST /api/2.0/files/file/{fileId}/edit_session Create the editing session
createFile POST /api/2.0/files/{folderId}/file Create a file
createFileInMyDocuments POST /api/2.0/files/@my/file Create a file in My documents
createFilePrimaryExternalLink POST /api/2.0/files/file/{id}/link Create the file primary external link
createHtmlFile POST /api/2.0/files/{folderId}/html Create an HTML file
createHtmlFileInMyDocuments POST /api/2.0/files/@my/html Create an HTML file in My documents
createTextFile POST /api/2.0/files/{folderId}/text Create a text file
createTextFileInMyDocuments POST /api/2.0/files/@my/text Create a text file in My documents
createThumbnails POST /api/2.0/files/thumbnails Queue file thumbnails
deleteFile DELETE /api/2.0/files/file/{fileId} Delete a file
deleteRecent DELETE /api/2.0/files/recent Delete recent files
deleteTemplates DELETE /api/2.0/files/templates Delete template files
generateXlsx POST /api/2.0/files/file/{fileId}/xlsx Generate a form answers report
getAllFormRoles GET /api/2.0/files/file/{fileId}/formroles Get form roles
getEditDiffUrl GET /api/2.0/files/file/{fileId}/edit/diff Get changes URL
getEditHistory GET /api/2.0/files/file/{fileId}/edit/history Get version history
getEncryptionInfo GET /api/2.0/files/{fileId}/access Get file encryption information
getFileHistory GET /api/2.0/files/file/{fileId}/log Get file history
getFileInfo GET /api/2.0/files/file/{fileId} Get file information
getFileLinks GET /api/2.0/files/file/{id}/links Get file external links
getFilePrimaryExternalLink GET /api/2.0/files/file/{id}/link Get the file primary external link
getFileVersionInfo GET /api/2.0/files/file/{fileId}/history Get file versions
getFillResult GET /api/2.0/files/file/fillresult Get form-filling result
getFormSubmissions GET /api/2.0/files/file/{fileId}/submissions Get form submission results
getPresignedFileUri GET /api/2.0/files/file/{fileId}/presigned Get a signed download address
getPresignedUri GET /api/2.0/files/file/{fileId}/presigneduri Get file download link
getProtectedFileUsers GET /api/2.0/files/file/{fileId}/protectusers Get users for document protection
getReferenceData POST /api/2.0/files/file/referencedata Resolve a spreadsheet reference
getXlsx GET /api/2.0/files/file/{fileId}/xlsx Get form report generation status
isFormPDF GET /api/2.0/files/file/{fileId}/isformpdf Check the PDF file
lockFile PUT /api/2.0/files/file/{fileId}/lock Lock a file
manageFormFilling PUT /api/2.0/files/file/{fileId}/manageformfilling Perform form filling action
openEditFile GET /api/2.0/files/file/{fileId}/openedit Get the editor configuration
restoreFileVersion POST /api/2.0/files/file/{fileId}/restoreversion Restore a file version
saveEditingFileFromForm PUT /api/2.0/files/file/{fileId}/saveediting Save edited file content
saveFileAsPdf POST /api/2.0/files/file/{id}/saveaspdf Save a file as PDF
saveFormRoleMapping POST /api/2.0/files/file/{fileId}/formrolemapping Save form role mapping
setCustomFilterTag PUT /api/2.0/files/file/{fileId}/customfilter Set the Custom Filter editing mode
setEncryptionInfo PUT /api/2.0/files/{fileId}/access Set file encryption information
setFileExternalLink PUT /api/2.0/files/file/{id}/links Set a file external link
setFileOrder PUT /api/2.0/files/{fileId}/order Set file order
setFilesOrder PUT /api/2.0/files/order Set order of files
startEditFile POST /api/2.0/files/file/{fileId}/startedit Open an editing session
startFillingFile PUT /api/2.0/files/file/{fileId}/startfilling Start filling a form
toggleFileFavorite GET /api/2.0/files/favorites/{fileId} Set the file favorite status
trackEditFile GET /api/2.0/files/file/{fileId}/trackeditfile Track an editing session
updateFile PUT /api/2.0/files/file/{fileId} Update a file
FoldersApi
checkUpload POST /api/2.0/files/{folderId}/upload/check Check for upload conflicts
createFolder POST /api/2.0/files/folder/{folderId} Create a folder
createFolderPrimaryExternalLink POST /api/2.0/files/folder/{id}/link Create the folder primary external link
createReportFolderHistory POST /api/2.0/files/folder/{folderId}/log/report Start the folder history report generation
deleteFolder DELETE /api/2.0/files/folder/{folderId} Delete a folder
generateXlsxByFolder POST /api/2.0/files/folder/{folderId}/xlsx Generate XLSX report by folder
getFavoritesFolder GET /api/2.0/files/@favorites Get the Favorites section
getFilesUsedSpace GET /api/2.0/files/filesusedspace Get used space of files
getFolder GET /api/2.0/files/{folderId}/formfilter Get folder form filter
getFolderByFolderId GET /api/2.0/files/{folderId} Get a folder by ID
getFolderHistory GET /api/2.0/files/folder/{folderId}/log Get folder history
getFolderInfo GET /api/2.0/files/folder/{folderId} Get folder information
getFolderLinks GET /api/2.0/files/folder/{id}/links Get folder external links
getFolderPath GET /api/2.0/files/folder/{folderId}/path Get the folder path
getFolderPrimaryExternalLink GET /api/2.0/files/folder/{id}/link Get the folder primary external link
getFolders GET /api/2.0/files/{folderId}/subfolders Get subfolders
getFormsFolder GET /api/2.0/files/@forms Get the Forms section
getMyFolder GET /api/2.0/files/@my Get the My documents section
getNewFolderItems GET /api/2.0/files/{folderId}/news Get new folder items
getRecentFolder GET /api/2.0/files/recent Get the Recent section
getReportFolderHistory GET /api/2.0/files/folder/{folderId}/log/report Get the folder history report generation status
getRootFolders GET /api/2.0/files/@root Get filtered sections
getTrashFolder GET /api/2.0/files/@trash Get the Trash section
insertFile POST /api/2.0/files/{folderId}/insert Insert a file
insertFileToMyFromBody POST /api/2.0/files/@my/insert Insert a file into My documents
renameFolder PUT /api/2.0/files/folder/{folderId} Rename a folder
searchFolder POST /api/2.0/files/{folderId}/search Search a folder by metadata
setFolderOrder PUT /api/2.0/files/folder/{folderId}/order Set folder order
setFolderPrimaryExternalLink PUT /api/2.0/files/folder/{id}/links Set the folder external link
terminateReportFolderHistory DELETE /api/2.0/files/folder/{folderId}/log/report Terminate the folder history report generation
uploadFile POST /api/2.0/files/{folderId}/upload Upload a file
uploadFileToMy POST /api/2.0/files/@my/upload Upload a file to My documents
MetadataApi
assignFileTemplates PUT /api/2.0/files/metadata/file/{fileId}/templates Assign templates to a file
assignFolderTemplates PUT /api/2.0/files/metadata/folder/{folderId}/templates Assign templates to a folder
createField POST /api/2.0/files/metadata/templates/{templateId}/fields Add a metadata field
createTemplate POST /api/2.0/files/metadata/templates Create a metadata template
deleteField DELETE /api/2.0/files/metadata/templates/{templateId}/fields/{fieldId} Delete a metadata field
deleteTemplate DELETE /api/2.0/files/metadata/templates/{templateId} Delete a metadata template
getCascadeProgress GET /api/2.0/files/metadata/folder/{folderId}/templates/progress Get cascade progress
getFileMetadata GET /api/2.0/files/metadata/file/{fileId} Get file metadata
getFolderMetadata GET /api/2.0/files/metadata/folder/{folderId} Get folder metadata
getTemplate GET /api/2.0/files/metadata/templates/{templateId} Get a metadata template
getTemplates GET /api/2.0/files/metadata/templates Get metadata templates
setFileCustomFields PUT /api/2.0/files/metadata/file/{fileId}/customfields Set file custom fields
setFileValues PUT /api/2.0/files/metadata/file/{fileId}/values Set file metadata values
setFolderCustomFields PUT /api/2.0/files/metadata/folder/{folderId}/customfields Set folder custom fields
setFolderValues PUT /api/2.0/files/metadata/folder/{folderId}/values Set folder metadata values
unassignFileTemplate DELETE /api/2.0/files/metadata/file/{fileId}/templates/{templateId} Unassign a template from a file
unassignFolderTemplate DELETE /api/2.0/files/metadata/folder/{folderId}/templates/{templateId} Unassign a template from a folder
updateField PUT /api/2.0/files/metadata/templates/{templateId}/fields/{fieldId} Update a metadata field
updateFolderTemplate PUT /api/2.0/files/metadata/folder/{folderId}/templates/{templateId} Update a template assignment on a folder
updateTemplate PUT /api/2.0/files/metadata/templates/{templateId} Update a metadata template
OperationsApi
abortUploadSession DELETE /api/2.0/files/{folderId}/session/{sessionId} Abort an upload session
addFavorites POST /api/2.0/files/favorites Add favorite files and folders
bulkDownload PUT /api/2.0/files/fileops/bulkdownload Bulk download
checkConversionStatus GET /api/2.0/files/file/{fileId}/checkconversion Get conversion status
checkMoveOrCopyBatchItems GET /api/2.0/files/fileops/move Check move or copy conflicts
checkMoveOrCopyDestFolder GET /api/2.0/files/fileops/checkdestfolder Check the destination folder
copyBatchItems PUT /api/2.0/files/fileops/copy Copy files and folders
createUploadSession POST /api/2.0/files/{folderId}/upload/create_session Chunked upload
createUploadSessionInFolder POST /api/2.0/files/{folderId}/session Create an upload session
deleteBatchItems PUT /api/2.0/files/fileops/delete Delete files and folders
deleteFavoritesFromBody DELETE /api/2.0/files/favorites Delete favorite files and folders
deleteFileVersions PUT /api/2.0/files/fileops/deleteversion Delete file versions
duplicateBatchItems PUT /api/2.0/files/fileops/duplicate Duplicate files and folders
emptyTrash PUT /api/2.0/files/fileops/emptytrash Empty the Trash folder
finalizeSession PUT /api/2.0/files/{folderId}/session/{sessionId}/finalize Finalize an upload session
getOperationStatuses GET /api/2.0/files/fileops Get active file operations
getOperationStatusesByType GET /api/2.0/files/fileops/{operationType} Get file operations by type
markAsRead PUT /api/2.0/files/fileops/markasread Mark files and folders as read
moveBatchItems PUT /api/2.0/files/fileops/move Move files and folders
startFileConversion PUT /api/2.0/files/file/{fileId}/checkconversion Start file conversion
terminateTasks PUT /api/2.0/files/fileops/terminate/{id} Cancel file operations
updateFileComment PUT /api/2.0/files/file/{fileId}/comment Update a comment
uploadAsyncSession POST /api/2.0/files/{folderId}/session/{sessionId}/upload Upload a numbered chunk
uploadSession POST /api/2.0/files/{folderId}/session/{sessionId} Upload the next chunk
QuotaApi
resetRoomQuota PUT /api/2.0/files/rooms/resetquota Reset the room quota limit
updateRoomsQuota PUT /api/2.0/files/rooms/roomquota Change the room quota limit
SettingsApi
changeAccessToThirdparty PUT /api/2.0/files/thirdparty Change the third-party settings access
changeAutomaticallyCleanUp PUT /api/2.0/files/settings/autocleanup Update the trash bin auto-clearing setting
changeDefaultAccessRights PUT /api/2.0/files/settings/dafaultaccessrights Change the default access rights
changeDeleteConfirm PUT /api/2.0/files/changedeleteconfrim Ask for delete confirmation
changeDownloadZip PUT /api/2.0/files/settings/downloadtargz Change the download archive format
changeExternalSharingSettings PUT /api/2.0/files/settings/externalsharingsettings Configure external sharing
checkDocServiceUrl PUT /api/2.0/files/docservice Set the document service address
displayFileExtension PUT /api/2.0/files/displayfileextension Display a file extension
displayRecent PUT /api/2.0/files/displayrecent Show the Recent section
externalShare PUT /api/2.0/files/settings/external Change the external sharing ability
externalShareSocialMedia PUT /api/2.0/files/settings/externalsocialmedia Change the external sharing ability on social networks
forcesave PUT /api/2.0/files/forcesave Change the forcesaving ability
getAutomaticallyCleanUp GET /api/2.0/files/settings/autocleanup Get the trash bin auto-clearing setting
getDefaultTemplates GET /api/2.0/files/settings/defaulttemplate Get the default template setting
getDocServiceUrl GET /api/2.0/files/docservice Get the document service address
getFilesModule GET /api/2.0/files/info Get the Documents module information
getFilesSettings GET /api/2.0/files/settings Get file settings
hideConfirmCancelOperation PUT /api/2.0/files/hideconfirmcanceloperation Hide confirmation dialog when canceling operations
hideConfirmConvert PUT /api/2.0/files/hideconfirmconvert Hide the confirmation dialog when converting
hideConfirmRoomLifetime PUT /api/2.0/files/hideconfirmroomlifetime Hide confirmation dialog when changing room lifetime settings
keepNewFileName PUT /api/2.0/files/keepnewfilename Keep the default file name
resetDefaultTemplate DELETE /api/2.0/files/settings/defaulttemplate Reset the default template setting
setDefaultTemplate PUT /api/2.0/files/settings/defaulttemplate Change the default template setting
setOpenEditorInSameTab PUT /api/2.0/files/settings/openeditorinsametab Open document in the same browser tab
setOrganizeRoomsGrouping PUT /api/2.0/files/settings/organizegrouping Organize rooms grouping
showQuickActions PUT /api/2.0/files/showquickactions Display quick actions
storeForcesave PUT /api/2.0/files/storeforcesave Change the ability to store the forcesaved files
storeOriginal PUT /api/2.0/files/storeoriginal Change the ability to upload original formats
updateFileIfExist PUT /api/2.0/files/updateifexist Update a file version if it exists
uploadDefaultTemplate POST /api/2.0/files/settings/defaulttemplate Upload a file as the default template setting
SharingApi
applyExternalSharePassword POST /api/2.0/files/share/{key}/password Unlock a password-protected link
changeFileOwner POST /api/2.0/files/owner Change the room or file owner
getEncryptionAccess GET /api/2.0/files/file/{fileId}/publickeys Get file encryption keys
getExternalShareData GET /api/2.0/files/share/{key} Resolve an external share link
getFileSecurityInfo GET /api/2.0/files/file/{id}/share Get file sharing rights
getFolderSecurityInfo GET /api/2.0/files/folder/{id}/share Get folder sharing rights
getGroupsMembersWithFileSecurity GET /api/2.0/files/file/{fileId}/group/{groupId}/share Get file access of group members
getGroupsMembersWithFolderSecurity GET /api/2.0/files/folder/{folderId}/group/{groupId}/share Get folder access of group members
getSecurityInfo POST /api/2.0/files/share Get sharing rights in batch
getSharedUsers GET /api/2.0/files/file/{fileId}/sharedusers Get users to mention in a file
removeSecurityInfo DELETE /api/2.0/files/share Remove sharing rights in batch
sendEditorNotify POST /api/2.0/files/file/{fileId}/sendeditornotify Notify mentioned users
setFileSecurityInfo PUT /api/2.0/files/file/{id}/share Share a file
setFolderSecurityInfo PUT /api/2.0/files/folder/{id}/share Share a folder
setSecurityInfo PUT /api/2.0/files/share Set sharing rights in batch
ThirdPartyIntegrationApi
deleteThirdParty DELETE /api/2.0/files/thirdparty/{providerId} Remove a third-party account
getAllProviders GET /api/2.0/files/thirdparty/providers Get all third-party providers
getBackupThirdPartyAccount GET /api/2.0/files/thirdparty/backup Get the third-party backup folder
getCapabilities GET /api/2.0/files/thirdparty/capabilities Get third-party provider capabilities
getCommonThirdPartyFolders GET /api/2.0/files/thirdparty/common Get common third-party folders
getThirdPartyAccounts GET /api/2.0/files/thirdparty Get the third-party accounts
saveThirdParty POST /api/2.0/files/thirdparty Connect a third-party account
saveThirdPartyBackup POST /api/2.0/files/thirdparty/backup Connect the third-party backup storage
Group
Method HTTP request Description
GroupApi
addGroup POST /api/2.0/group Add a new group
addMembersTo PUT /api/2.0/group/{id}/members Add group members
deleteGroup DELETE /api/2.0/group/{id} Delete a group
getGroup GET /api/2.0/group/{id} Get a group
getGroupByUserId GET /api/2.0/group/user/{userId} Get user groups
getGroups GET /api/2.0/group Get groups
moveMembersTo PUT /api/2.0/group/{fromId}/members/{toId} Move group members
removeMembersFrom DELETE /api/2.0/group/{id}/members Remove group members
setGroupManager PUT /api/2.0/group/{id}/manager Set a group manager
setMembersTo POST /api/2.0/group/{id}/members Replace group members
updateGroup PUT /api/2.0/group/{id} Update a group
SearchApi
getGroupsWithFilesShared GET /api/2.0/group/file/{id} Search groups for a file
getGroupsWithFoldersShared GET /api/2.0/group/folder/{id} Search groups for a folder
getGroupsWithRoomsShared GET /api/2.0/group/room/{id} Search groups for a room
Migration
Method HTTP request Description
MigrationApi
cancelMigration POST /api/2.0/migration/cancel Cancel migration
clearMigration POST /api/2.0/migration/clear Clear migration
finishMigration POST /api/2.0/migration/finish Finish migration
getMigrationLogs GET /api/2.0/migration/logs Get migration logs
getMigrationStatus GET /api/2.0/migration/status Get migration status
listMigrations GET /api/2.0/migration/list Get available migrators
startMigration POST /api/2.0/migration/migrate Start migration
uploadAndInitializeMigration POST /api/2.0/migration/init/{migratorName} Parse migration archive
OAuth20
Method HTTP request Description
AuthorizationApi
authorizeOAuth GET /oauth2/authorize Start the authorization flow
exchangeToken POST /oauth2/token Exchange the authorization code
submitConsent POST /oauth2/authorize Submit the consent decision
ClientManagementApi
changeActivation PATCH /api/2.0/oauth2/clients/{clientId}/activation Change client activation status
createClient POST /api/2.0/oauth2/clients Create a new OAuth2 client
deleteClient DELETE /api/2.0/oauth2/clients/{clientId} Delete an OAuth2 client
deleteTenantClients DELETE /api/2.0/oauth2/clients/tenant Delete all tenant OAuth2 clients
deleteUserClients DELETE /api/2.0/oauth2/clients Delete all user OAuth2 clients
regenerateSecret PATCH /api/2.0/oauth2/clients/{clientId}/regenerate Regenerate client secret
revokeUserClient DELETE /api/2.0/oauth2/clients/{clientId}/revoke Revoke client consent
updateClient PUT /api/2.0/oauth2/clients/{clientId} Update an existing OAuth2 client
ClientQueryingApi
getClient GET /api/2.0/oauth2/clients/{clientId} Get client details
getClientInfo GET /api/2.0/oauth2/clients/{clientId}/info Get client info
getClients GET /api/2.0/oauth2/clients List clients
getClientsInfo GET /api/2.0/oauth2/clients/info List client info
getConsents GET /api/2.0/oauth2/clients/consents List user consents
getPublicClientInfo GET /api/2.0/oauth2/clients/{clientId}/public/info Get public client info
DiscoveryApi
handleOptions OPTIONS /.well-known/oauth-authorization-server Probe the discovery endpoint
ScopeManagementApi
getScopes GET /api/2.0/oauth2/scopes List available OAuth2 scopes
People
Method HTTP request Description
EmailApi
changeUserEmail PUT /api/2.0/people/{userId}/email Change a user email
sendEmailChangeInstructions POST /api/2.0/people/email Send instructions to change email
GuestsApi
approveGuestShareLink POST /api/2.0/people/guests/share/approve Approve a guest sharing link
deleteGuests DELETE /api/2.0/people/guests Remove guest relations
PasswordApi
changeUserPassword PUT /api/2.0/people/{userId}/password Change a user password
sendUserPassword POST /api/2.0/people/password Remind a user password
PhotosApi
createMemberPhotoThumbnails POST /api/2.0/people/{userId}/photo/thumbnails Create photo thumbnails
deleteMemberPhoto DELETE /api/2.0/people/{userId}/photo Delete a user photo
getMemberPhoto GET /api/2.0/people/{userId}/photo Get a user photo
updateMemberPhoto PUT /api/2.0/people/{userId}/photo Update a user photo
uploadMemberPhoto POST /api/2.0/people/{userId}/photo Upload a user photo
ProfilesApi
addMember POST /api/2.0/people Add a user
checkUserExistsByEmail GET /api/2.0/people/exists Check whether an email is taken
deleteMember DELETE /api/2.0/people/{userId} Delete a user
deleteProfile DELETE /api/2.0/people/@self Close my own profile
getAllProfiles GET /api/2.0/people Get the active profiles
getClaims GET /api/2.0/people/tokendiagnostics Get user claims
getProfileByEmail GET /api/2.0/people/email Get a profile by user email
getProfileByUserId GET /api/2.0/people/{userId} Get a profile by user ID
getSelfProfile GET /api/2.0/people/@self Get my profile
inviteUsers POST /api/2.0/people/invite Invite users
removeUsers PUT /api/2.0/people/delete Delete users
resendUserInvites PUT /api/2.0/people/invite Resend activation emails
updateMember PUT /api/2.0/people/{userId} Update a user
updateMemberCulture PUT /api/2.0/people/{userId}/culture Update a user culture
QuotaApi
resetUsersQuota PUT /api/2.0/people/resetquota Reset a user quota limit
updateUserQuota PUT /api/2.0/people/userquota Change a user quota limit
SearchApi
getAccountsEntriesWithFilesShared GET /api/2.0/accounts/file/{id}/search Search accounts for a file
getAccountsEntriesWithFoldersShared GET /api/2.0/accounts/folder/{id}/search Search accounts for a folder
getAccountsEntriesWithRoomsShared GET /api/2.0/accounts/room/{id}/search Search accounts for a room
getSearch GET /api/2.0/people/@search/{query} Search users
getSimpleByFilter GET /api/2.0/people/simple/filter Filter users in brief
getUsersWithFilesShared GET /api/2.0/people/file/{id} Search users for a file
getUsersWithFoldersShared GET /api/2.0/people/folder/{id} Search users for a folder
getUsersWithRoomShared GET /api/2.0/people/room/{id} Search users for a room
searchUsersByExtendedFilter GET /api/2.0/people/filter Filter users in detail
searchUsersByQuery GET /api/2.0/people/search Search users by query
searchUsersByStatus GET /api/2.0/people/status/{status}/search Search users by status filter
ThemeApi
changePortalTheme PUT /api/2.0/people/theme Change the portal theme
getPortalTheme GET /api/2.0/people/theme Get the portal theme
ThirdPartyAccountsApi
getThirdPartyAuthProviders GET /api/2.0/people/thirdparty/providers Get third-party providers
linkThirdPartyAccount PUT /api/2.0/people/thirdparty/linkaccount Link a third-party account
signupThirdPartyAccount POST /api/2.0/people/thirdparty/signup Sign up with a provider
unlinkThirdPartyAccount DELETE /api/2.0/people/thirdparty/unlinkaccount Unlink a third-party account
UserDataApi
getDeletePersonalFolderProgress GET /api/2.0/people/delete/personal/progress Get the personal folder deletion progress
getReassignProgress GET /api/2.0/people/reassign/progress/{userId} Get the reassignment progress
getRemoveProgress GET /api/2.0/people/remove/progress/{userId} Get the deletion progress
necessaryReassign GET /api/2.0/people/reassign/necessary Check data for reassignment need
sendInstructionsToDelete PUT /api/2.0/people/self/delete Send the deletion instructions
startDeletePersonalFolder POST /api/2.0/people/delete/personal/start Delete the personal folder
startReassign POST /api/2.0/people/reassign/start Start the data reassignment
startRemove POST /api/2.0/people/remove/start Start the data deletion
terminateReassign PUT /api/2.0/people/reassign/terminate Terminate the data reassignment
terminateRemove PUT /api/2.0/people/remove/terminate Terminate the data deletion
UserStatusApi
getByStatus GET /api/2.0/people/status/{status} Get profiles by status
updateUserActivationStatus PUT /api/2.0/people/activationstatus/{activationStatus} Set my activation status
updateUserStatus PUT /api/2.0/people/status/{status} Change a user status
UserTypeApi
getUserTypeUpdateProgress GET /api/2.0/people/type/progress/{userId} Get the user type change progress
startUserTypeUpdate POST /api/2.0/people/type Start updating user type
terminateUserTypeUpdate PUT /api/2.0/people/type/terminate Terminate updating user type
updateUserType PUT /api/2.0/people/type/{type} Change a user type
Portal
Method HTTP request Description
GuestsApi
getGuestSharingLink GET /api/2.0/people/guests/{userId}/share Get a guest sharing link
PaymentApi
calculateWalletPayment PUT /api/2.0/portal/payment/calculatewallet Calculate the wallet payment amount
changeTenantWalletServiceState POST /api/2.0/portal/payment/servicestate Switch a wallet service
createCustomerMonthlyUsageReport POST /api/2.0/portal/payment/customer/usage/monthly/report Start the monthly usage report
createCustomerOperationsReport POST /api/2.0/portal/payment/customer/operationsreport Start the operations report
createCustomerServiceUsageReport POST /api/2.0/portal/payment/customer/usage/report Start the service usage report
getAccountingServicePrices GET /api/2.0/portal/payment/accounting/prices/{serviceName} Get the service prices from the accounting service
getActiveServices GET /api/2.0/portal/payment/activeservices Get the active wallet services
getAiPrices GET /api/2.0/portal/payment/ai-prices Get AI model prices
getCheckoutSetupUrl GET /api/2.0/portal/payment/checkoutsetupurl Get the checkout setup page URL
getCustomerBalance GET /api/2.0/portal/payment/customer/balance Get the customer balance
getCustomerInfo GET /api/2.0/portal/payment/customerinfo Get the customer information
getCustomerMonthlyUsage GET /api/2.0/portal/payment/customer/usage/monthly Get the customer monthly usage
getCustomerMonthlyUsageReport GET /api/2.0/portal/payment/customer/usage/monthly/report Get the monthly usage report status
getCustomerOperations GET /api/2.0/portal/payment/customer/operations Get the wallet operations
getCustomerOperationsReport GET /api/2.0/portal/payment/customer/operationsreport Get the operations report status
getCustomerServiceUsage GET /api/2.0/portal/payment/customer/usage Get the customer service usage
getCustomerServiceUsageReport GET /api/2.0/portal/payment/customer/usage/report Get the service usage report status
getPaymentAccount GET /api/2.0/portal/payment/account Get the billing account page
getPaymentCurrencies GET /api/2.0/portal/payment/currencies Get the billing currencies
getPaymentQuotas GET /api/2.0/portal/payment/quotas Get the purchasable quotas
getPaymentUrl PUT /api/2.0/portal/payment/url Get the payment page URL
getPortalPrices GET /api/2.0/portal/payment/prices Get the product prices
getQuotaPaymentInformation GET /api/2.0/portal/payment/quota Get the current plan and limits
getRestrictedAiModels GET /api/2.0/portal/payment/ai-model/restrictions Get restricted AI models
getSubscriptionBalanceInfo GET /api/2.0/portal/payment/subscription/balance Get the subscription balance information
getTenantWalletServiceSettings GET /api/2.0/portal/payment/servicessettings Get the wallet service settings
getTenantWalletSettings GET /api/2.0/portal/payment/topupsettings Get the auto top-up settings
getWalletService GET /api/2.0/portal/payment/walletservice Get a wallet service
getWalletServices GET /api/2.0/portal/payment/walletservices Get wallet services
moveSubscriptionToWallet POST /api/2.0/portal/payment/subscription/movetowallet Move the subscription to the wallet
sendPaymentRequest POST /api/2.0/portal/payment/request Contact the sales team
setRestrictedAiModels PUT /api/2.0/portal/payment/ai-model/restrictions Set restricted AI models
setTenantWalletSettings POST /api/2.0/portal/payment/topupsettings Set the auto top-up settings
terminateCustomerMonthlyUsageReport DELETE /api/2.0/portal/payment/customer/usage/monthly/report Terminate the monthly usage report
terminateCustomerOperationsReport DELETE /api/2.0/portal/payment/customer/operationsreport Terminate the operations report
terminateCustomerServiceUsageReport DELETE /api/2.0/portal/payment/customer/usage/report Terminate the service usage report
topUpDeposit POST /api/2.0/portal/payment/deposit Top up the wallet
updatePayment PUT /api/2.0/portal/payment/update Change the subscription quantity
updateWalletPayment PUT /api/2.0/portal/payment/updatewallet Change a wallet service quantity
QuotaApi
getPortalQuota GET /api/2.0/portal/quota Get the portal quota
getPortalTariff GET /api/2.0/portal/tariff Get the portal tariff
getPortalUsedSpace GET /api/2.0/portal/usedspace Get the portal used space
getRightQuota GET /api/2.0/portal/quota/right Get the recommended quota
getUpcomingPayments GET /api/2.0/portal/tariff/upcoming Get upcoming payments
SettingsApi
continuePortal PUT /api/2.0/portal/continue Restore a portal
deletePortal DELETE /api/2.0/portal/delete Delete a portal
getPortalInformation GET /api/2.0/portal Get portal information
getPortalPath GET /api/2.0/portal/path Get a path to the portal
sendDeleteInstructions POST /api/2.0/portal/delete Send removal instructions
sendSuspendInstructions POST /api/2.0/portal/suspend Send suspension instructions
suspendPortal PUT /api/2.0/portal/suspend Deactivate a portal
unblockPortal PUT /api/2.0/portal/unblock Unblock a portal
UsersApi
createInvitationLink POST /api/2.0/portal/users/invitationlink Create an invitation link
deleteInvitationLink DELETE /api/2.0/portal/users/invitationlink Delete an invitation link
getInvitationLink GET /api/2.0/portal/users/invite/{employeeType} Get a legacy invitation link
getInvitationLinkByEmployeeType GET /api/2.0/portal/users/invitationlink/{employeeType} Get an invitation link by role
getPortalUsersCount GET /api/2.0/portal/userscount Get a number of portal users
getUserById GET /api/2.0/portal/users/{userId} Get a portal user
markGiftMessageAsRead POST /api/2.0/portal/present/mark Mark a gift message as read
sendCongratulations POST /api/2.0/portal/sendcongratulations Send congratulations
updateInvitationLink PUT /api/2.0/portal/users/invitationlink Update an invitation link
Rooms
Method HTTP request Description
RoomsApi
addRoomTags PUT /api/2.0/files/rooms/{id}/tags Attach tags to a room
archiveRoom PUT /api/2.0/files/rooms/{id}/archive Archive a room
changeRoomCover POST /api/2.0/files/rooms/{id}/cover Change the room cover
createRoom POST /api/2.0/files/rooms Create a room
createRoomFromTemplate POST /api/2.0/files/rooms/fromtemplate Create a room from the template
createRoomLogo POST /api/2.0/files/rooms/{id}/logo Set the room logo
createRoomTag POST /api/2.0/files/tags Create a room tag
createRoomTemplate POST /api/2.0/files/roomtemplate Create a room template
createRoomThirdParty POST /api/2.0/files/rooms/thirdparty/{id} Create a third-party room
deleteCustomTags DELETE /api/2.0/files/tags Delete the custom room tags
deleteRoom DELETE /api/2.0/files/rooms/{id} Remove a room
deleteRoomLogo DELETE /api/2.0/files/rooms/{id}/logo Remove a room logo
deleteRoomTags DELETE /api/2.0/files/rooms/{id}/tags Detach tags from a room
getExternalDbSyncStatus GET /api/2.0/files/rooms/{id}/externaldbsync Get external DB sync status
getNewRoomItems GET /api/2.0/files/rooms/{id}/news Get new items in a room
getPublicSettings GET /api/2.0/files/roomtemplate/{id}/public Get room template public access
getRoomAiFolder GET /api/2.0/files/rooms/{id}/ai Get the .ai folder of a room
getRoomCovers GET /api/2.0/files/rooms/covers Get room cover gallery
getRoomCreatingStatus GET /api/2.0/files/rooms/fromtemplate/status Get the room creation progress
getRoomIndexExport GET /api/2.0/files/rooms/indexexport Get the room index export
getRoomInfo GET /api/2.0/files/rooms/{id} Get room information
getRoomLinks GET /api/2.0/files/rooms/{id}/links Get the room links
getRoomSecurityInfo GET /api/2.0/files/rooms/{id}/share Get the room access rights
getRoomTagsInfo GET /api/2.0/files/tags Get available room tags
getRoomTemplateCreatingStatus GET /api/2.0/files/roomtemplate/status Get room template creation status
getRoomsFolder GET /api/2.0/files/rooms Get rooms
getRoomsNewItems GET /api/2.0/files/rooms/news Get new items in all rooms
getRoomsPrimaryExternalLink GET /api/2.0/files/rooms/{id}/link Get the room primary external link
hasTagLinks GET /api/2.0/files/tags/{tagName}/haslinks Check room tag usage
pinRoom PUT /api/2.0/files/rooms/{id}/pin Pin a room
reorderRoom PUT /api/2.0/files/rooms/{id}/reorder Reorder room contents
resendEmailInvitations POST /api/2.0/files/rooms/{id}/resend Resend the room invitations
searchRooms POST /api/2.0/files/rooms/search Search the rooms by metadata
setPublicSettings PUT /api/2.0/files/roomtemplate/public Set room template public access
setRoomLink PUT /api/2.0/files/rooms/{id}/links Set the room external or invitation link
setRoomSecurity PUT /api/2.0/files/rooms/{id}/share Set the room access rights
startExternalDbSync POST /api/2.0/files/rooms/{id}/externaldbsync Start external DB sync
startRoomIndexExport POST /api/2.0/files/rooms/{id}/indexexport Start the room index export
terminateRoomIndexExport DELETE /api/2.0/files/rooms/indexexport Terminate the room index export
unarchiveRoom PUT /api/2.0/files/rooms/{id}/unarchive Unarchive a room
unpinRoom PUT /api/2.0/files/rooms/{id}/unpin Unpin a room
updateRoom PUT /api/2.0/files/rooms/{id} Update a room
updateRoomTag PUT /api/2.0/files/tags Rename a room tag
uploadRoomLogo POST /api/2.0/files/logos Upload a room logo image
GroupsApi
addRoomGroup POST /api/2.0/files/group Add a new room group
changeRoomGroupIcon POST /api/2.0/files/group/{id}/icon Change room group icon
deleteRoomGroup DELETE /api/2.0/files/group/{id} Delete a room group
getRoomGroupInfo GET /api/2.0/files/group/{id} Get room group info
getRoomGroups GET /api/2.0/files/group List room groups
updateRoomGroup PUT /api/2.0/files/group/{id} Update room group
PrivacyRoomApi
deleteKeys DELETE /api/2.0/privacyroom/keys/{id} Delete an encryption key
getUserKeys GET /api/2.0/privacyroom/keys Get own encryption keys
getUserKeysForRoom GET /api/2.0/privacyroom/{roomId}/access Get private room access keys
replaceKey PUT /api/2.0/privacyroom/keys Rotate an encryption key
setKeys POST /api/2.0/privacyroom/keys Create an encryption key
Security
Method HTTP request Description
AccessToDevToolsApi
setTenantDevToolsAccessSettings POST /api/2.0/settings/devtoolsaccess Set the Developer Tools access settings
ActiveConnectionsApi
getAllActiveConnections GET /api/2.0/security/activeconnections Get active connections
logOutActiveConnection PUT /api/2.0/security/activeconnections/logout/{loginEventId} Log out one connection
logOutAllActiveConnectionsChangePassword PUT /api/2.0/security/activeconnections/logoutallchangepassword Log out and reset password
logOutAllActiveConnectionsForUser PUT /api/2.0/security/activeconnections/logoutall/{userId} Log out a user everywhere
logOutAllExceptThisConnection PUT /api/2.0/security/activeconnections/logoutallexceptthis Log out other connections
AuditTrailDataApi
createAuditTrailReport POST /api/2.0/security/audit/events/report Start audit trail report
getAuditEventsByFilter GET /api/2.0/security/audit/events/filter Get filtered audit events
getAuditSettings GET /api/2.0/security/audit/settings/lifetime Get audit lifetime settings
getAuditTrailMappers GET /api/2.0/security/audit/mappers Get audit trail mappers
getAuditTrailReport GET /api/2.0/security/audit/events/report Get audit trail report status
getAuditTrailTypes GET /api/2.0/security/audit/types Get audit trail types
getLastAuditEvents GET /api/2.0/security/audit/events/last Get recent audit events
setAuditSettings POST /api/2.0/security/audit/settings/lifetime Set audit lifetime settings
terminateAuditTrailReport DELETE /api/2.0/security/audit/events/report Terminate audit trail report
BannersVisibilityApi
setTenantBannerSettings POST /api/2.0/settings/banner Set the banners visibility
CSPApi
configureCsp POST /api/2.0/security/csp Configure CSP settings
getCspSettings GET /api/2.0/security/csp Get CSP settings
FirebaseApi
docRegisterPusnNotificationDevice POST /api/2.0/settings/push/docregisterdevice Register a push device
subscribeDocumentsPushNotification PUT /api/2.0/settings/push/docsubscribe Set push subscription
LoginHistoryApi
createLoginHistoryReport POST /api/2.0/security/audit/login/report Start login history report
getLastLoginEvents GET /api/2.0/security/audit/login/last Get recent login events
getLoginEventsByFilter GET /api/2.0/security/audit/login/filter Get filtered login events
getLoginHistoryReport GET /api/2.0/security/audit/login/report Get login history report status
terminateLoginHistoryReport DELETE /api/2.0/security/audit/login/report Terminate login history report
OAuth2Api
generateJwtToken GET /api/2.0/security/oauth2/token Generate JWT token
SMTPSettingsApi
getSmtpOperationStatus GET /api/2.0/smtpsettings/smtp/test/status Get SMTP test status
getSmtpSettings GET /api/2.0/smtpsettings/smtp Get SMTP settings
resetSmtpSettings DELETE /api/2.0/smtpsettings/smtp Reset SMTP settings
saveSmtpSettings POST /api/2.0/smtpsettings/smtp Save SMTP settings
testSmtpSettings GET /api/2.0/smtpsettings/smtp/test Test SMTP settings
Settings
Method HTTP request Description
AccessToDevToolsApi
getTenantAccessDevToolsSettings GET /api/2.0/settings/devtoolsaccess Get the Developer Tools access settings
AuthorizationApi
getAuthServices GET /api/2.0/settings/authservice Get the authorization services
saveAuthKeys POST /api/2.0/settings/authservice Save the authorization keys
testExternalDatabaseConnection POST /api/2.0/settings/authservice/externaldb/test Test external database connection
BannersVisibilityApi
getTenantBannerSettings GET /api/2.0/settings/banner Get the banners visibility
CommonSettingsApi
closeAdminHelper PUT /api/2.0/settings/closeadminhelper Close the admin helper
completeWizard PUT /api/2.0/settings/wizard/complete Complete the Wizard settings
configureDeepLink POST /api/2.0/settings/deeplink Configure the deep link settings
deletePortalColorTheme DELETE /api/2.0/settings/colortheme Delete a color theme
getDeepLinkSettings GET /api/2.0/settings/deeplink Get the deep link settings
getPaymentSettings GET /api/2.0/settings/payment Get the payment settings
getPortalColorTheme GET /api/2.0/settings/colortheme Get a color theme
getPortalHostname GET /api/2.0/settings/machine Get the portal hostname
getPortalLogo GET /api/2.0/settings/logo Get a portal logo
getPortalSettings GET /api/2.0/settings Get the portal settings
getSocketSettings GET /api/2.0/settings/socket Get the socket settings
getSupportedCultures GET /api/2.0/settings/cultures Get supported languages
getTenantAiAccessSettings GET /api/2.0/settings/ai-access Get the AI access settings
getTenantUserInvitationSettings GET /api/2.0/settings/invitationsettings Get the user invitation settings
getTimeZones GET /api/2.0/settings/timezones Get time zones
saveDefaultFolder PUT /api/2.0/settings/defaultfolder Set the default folder
saveDnsSettings PUT /api/2.0/settings/dns Save the DNS settings
saveMailDomainSettings POST /api/2.0/settings/maildomainsettings Save the mail domain settings
savePortalColorTheme PUT /api/2.0/settings/colortheme Save a color theme
setTenantAiAccessSettings POST /api/2.0/settings/ai-access Set the AI access settings
updateEmailActivationSettings PUT /api/2.0/settings/emailactivation Update the email activation settings
updateInvitationSettings PUT /api/2.0/settings/invitationsettings Update the user invitation settings
CookiesApi
getCookieSettings GET /api/2.0/settings/cookiesettings Get the cookie lifetime settings
updateCookieSettings PUT /api/2.0/settings/cookiesettings Update the cookie lifetime settings
DocsCloudApi
calculateDevPack POST /api/2.0/settings/docscloud/calculatedevpack Calculate the Docs Connect Dev Pack switch cost
createTenantQuotaReport POST /api/2.0/settings/docscloud/tenant/quota/report Start the Docs Connect quota report
getTenant GET /api/2.0/settings/docscloud/tenant Get the Docs Connect tenant
getTenantConfig GET /api/2.0/settings/docscloud/tenant/config Get the Docs Connect tenant configuration
getTenantInfo GET /api/2.0/settings/docscloud/tenant/info Get the Docs Connect tenant information
getTenantQuota GET /api/2.0/settings/docscloud/tenant/quota Get the Docs Connect tenant quota
getTenantQuotaReport GET /api/2.0/settings/docscloud/tenant/quota/report Get the Docs Connect quota report status
getTenantUsage GET /api/2.0/settings/docscloud/tenant/usage Get the Docs Connect tenant usage
startDocsCloudTrial POST /api/2.0/settings/docscloud/trial Start the Docs Connect trial
switchToDevPack POST /api/2.0/settings/docscloud/switchtodevpack Switch Docs Connect to Docs Connect Dev Pack
terminateTenantQuotaReport DELETE /api/2.0/settings/docscloud/tenant/quota/report Terminate the Docs Connect quota report
updateTenantConfig PUT /api/2.0/settings/docscloud/tenant/config Update the Docs Connect tenant configuration
EncryptionApi
getStorageEncryptionProgress GET /api/2.0/settings/encryption/progress Get the storage encryption progress
getStorageEncryptionSettings GET /api/2.0/settings/encryption/settings Get the storage encryption settings
startStorageEncryption POST /api/2.0/settings/encryption/start Start the storage encryption
GreetingSettingsApi
getGreetingSettings GET /api/2.0/settings/greetingsettings Get greeting settings
getIsDefaultGreetingSettings GET /api/2.0/settings/greetingsettings/isdefault Check the default greeting settings
restoreGreetingSettings POST /api/2.0/settings/greetingsettings/restore Restore the greeting settings
saveGreetingSettings POST /api/2.0/settings/greetingsettings Save the greeting settings
IPRestrictionsApi
getIpRestrictions GET /api/2.0/settings/iprestrictions Get IP restrictions
readIpRestrictionsSettings GET /api/2.0/settings/iprestrictions/settings Get IP restriction settings
saveIpRestrictions PUT /api/2.0/settings/iprestrictions Save IP restrictions
updateIpRestrictionsSettings PUT /api/2.0/settings/iprestrictions/settings Update IP restriction settings
LicenseApi
acceptLicense POST /api/2.0/settings/license/accept Activate a license
getIsLicenseRequired GET /api/2.0/settings/license/required Check if a license is required
refreshLicense GET /api/2.0/settings/license/refresh Refresh the license
uploadLicense POST /api/2.0/settings/license Upload a license
LoginSettingsApi
getLoginSettings GET /api/2.0/settings/security/loginsettings Get login settings
setDefaultLoginSettings DELETE /api/2.0/settings/security/loginsettings Reset login settings
updateLoginSettings PUT /api/2.0/settings/security/loginsettings Update login settings
MessagesApi
enableAdminMessageSettings POST /api/2.0/settings/messagesettings Enable or disable administrator messages
sendAdminMail POST /api/2.0/settings/sendadmmail Send a message to the administrator
sendJoinInviteMail POST /api/2.0/settings/sendjoininvite Send an invitation email
NotificationsApi
getNotificationChannels GET /api/2.0/settings/notification/channels Get notification channels
getNotificationSettings GET /api/2.0/settings/notification/{type} Check notification availability
getRoomsNotificationSettings GET /api/2.0/settings/notification/rooms Get muted rooms
setNotificationSettings POST /api/2.0/settings/notification Set notification status
setRoomsNotificationStatus POST /api/2.0/settings/notification/rooms Mute or unmute a room
OwnerApi
sendOwnerChangeInstructions POST /api/2.0/settings/owner Start the portal owner change
updatePortalOwner PUT /api/2.0/settings/owner Confirm the portal owner change
QuotaApi
getUserQuotaSettings GET /api/2.0/settings/userquotasettings Get the user quota settings
saveAiAgentQuotaSettings POST /api/2.0/settings/aiagentquotasettings Save the AI Agent quota settings
saveRoomQuotaSettings POST /api/2.0/settings/roomquotasettings Save the room quota settings
setTenantQuotaSettings PUT /api/2.0/settings/tenantquotasettings Save the tenant quota settings
RebrandingApi
deleteAdditionalWhiteLabelSettings DELETE /api/2.0/settings/rebranding/additional Delete the additional white label settings
deleteCompanyWhiteLabelSettings DELETE /api/2.0/settings/rebranding/company Delete the company white label settings
getAdditionalWhiteLabelSettings GET /api/2.0/settings/rebranding/additional Get the additional white label settings
getCompanyWhiteLabelSettings GET /api/2.0/settings/rebranding/company Get the company white label settings
getEnableWhitelabel GET /api/2.0/settings/enablewhitelabel Check the white label availability
getIsDefaultWhiteLabelLogoText GET /api/2.0/settings/whitelabel/logotext/isdefault Check the default logo text
getIsDefaultWhiteLabelLogos GET /api/2.0/settings/whitelabel/logos/isdefault Check the default white label logos
getLicensorData GET /api/2.0/settings/companywhitelabel Get the licensor data
getWhiteLabelLogoText GET /api/2.0/settings/whitelabel/logotext Get the white label logo text
getWhiteLabelLogos GET /api/2.0/settings/whitelabel/logos Get the white label logos
restoreWhiteLabelLogoText PUT /api/2.0/settings/whitelabel/logotext/restore Restore the white label logo text
restoreWhiteLabelLogos PUT /api/2.0/settings/whitelabel/logos/restore Restore the white label logos
saveAdditionalWhiteLabelSettings POST /api/2.0/settings/rebranding/additional Save the additional white label settings
saveCompanyWhiteLabelSettings POST /api/2.0/settings/rebranding/company Save the company white label settings
saveWhiteLabelLogoText POST /api/2.0/settings/whitelabel/logotext/save Save the white label logo text
saveWhiteLabelSettings POST /api/2.0/settings/whitelabel/logos/save Save the white label logos
saveWhiteLabelSettingsFromFiles POST /api/2.0/settings/whitelabel/logos/savefromfiles Save the logos from files
SSOApi
getDefaultSsoSettingsV2 GET /api/2.0/settings/ssov2/default Get the default SSO settings
getSsoSettingsV2 GET /api/2.0/settings/ssov2 Get the SSO settings
getSsoSettingsV2Constants GET /api/2.0/settings/ssov2/constants Get the SSO settings constants
resetSsoSettingsV2 DELETE /api/2.0/settings/ssov2 Reset the SSO settings
saveSsoSettingsV2 POST /api/2.0/settings/ssov2 Save the SSO settings
SecurityApi
getEnabledModules GET /api/2.0/settings/security/modules Get enabled modules
getIsProductAdministrator GET /api/2.0/settings/security/administrator Check product administrator
getPasswordSettings GET /api/2.0/settings/security/password Get password settings
getProductAdministrators GET /api/2.0/settings/security/administrator/{productId} Get product administrators
getWebItemSecurityInfo GET /api/2.0/settings/security/{id} Check module availability
getWebItemSettingsSecurityInfo GET /api/2.0/settings/security Get module access settings
setAccessToWebItems PUT /api/2.0/settings/security/access Set access to modules in bulk
setProductAdministrator PUT /api/2.0/settings/security/administrator Set product administrator
setWebItemSecurity PUT /api/2.0/settings/security Set module access
updatePasswordSettings PUT /api/2.0/settings/security/password Update password settings
StatisticsApi
getSpaceUsageStatistics GET /api/2.0/settings/statistics/spaceusage/{id} Get the space usage statistics
StorageApi
getAllBackupStorages GET /api/2.0/settings/storage/backup Get the backup storages
getAllCdnStorages GET /api/2.0/settings/storage/cdn Get the CDN storages
getAllStorages GET /api/2.0/settings/storage Get the portal storages
getAmazonS3Regions GET /api/2.0/settings/storage/s3/regions Get the Amazon S3 regions
getStorageProgress GET /api/2.0/settings/storage/progress Get the storage migration progress
resetCdnToDefault DELETE /api/2.0/settings/storage/cdn Reset the CDN storage settings
resetStorageToDefault DELETE /api/2.0/settings/storage Reset the storage settings
updateCdnStorage PUT /api/2.0/settings/storage/cdn Update the CDN storage
updateStorage PUT /api/2.0/settings/storage Switch the portal storage
TFASettingsApi
getTfaAppCodes GET /api/2.0/settings/tfaappcodes Get the TFA backup codes
getTfaConfirmData GET /api/2.0/settings/tfaapp/confirm Get TFA confirmation data
getTfaSettings GET /api/2.0/settings/tfaapp Get the TFA settings
tfaAppGenerateSetupCode GET /api/2.0/settings/tfaapp/setup Generate the TFA setup code
tfaValidateAuthCode POST /api/2.0/settings/tfaapp/validate Validate the TFA code
unlinkTfaApp PUT /api/2.0/settings/tfaappnewapp Unlink the TFA application
updateTfaAppCodes PUT /api/2.0/settings/tfaappnewcodes Regenerate the TFA backup codes
updateTfaSettings PUT /api/2.0/settings/tfaapp Update the TFA settings
updateTfaSettingsLink PUT /api/2.0/settings/tfaappwithlink Update TFA settings with a link
TelegramApi
checkTelegram GET /api/2.0/settings/telegram/check Check the Telegram connection
linkTelegram GET /api/2.0/settings/telegram/link Get the Telegram link
unlinkTelegram DELETE /api/2.0/settings/telegram/link Unlink Telegram
WebhooksApi
createWebhook POST /api/2.0/settings/webhook Create a webhook
enableWebhook PUT /api/2.0/settings/webhook/enable Switch a webhook on or off
getTenantWebhooks GET /api/2.0/settings/webhook Get the portal webhooks
getWebhookTriggers GET /api/2.0/settings/webhook/triggers Get the webhook triggers
getWebhooksLogs GET /api/2.0/settings/webhooks/log Get the webhook delivery log
removeWebhook DELETE /api/2.0/settings/webhook/{id} Remove a webhook
retryWebhook PUT /api/2.0/settings/webhook/{id}/retry Retry a webhook delivery
retryWebhooks PUT /api/2.0/settings/webhook/retry Retry webhook deliveries
updateWebhook PUT /api/2.0/settings/webhook Update a webhook
WebpluginsApi
addWebPluginFromFile POST /api/2.0/settings/webplugins Add a web plugin
deleteWebPlugin DELETE /api/2.0/settings/webplugins/{name} Delete a web plugin
getWebPlugin GET /api/2.0/settings/webplugins/{name} Get a web plugin by name
getWebPlugins GET /api/2.0/settings/webplugins Get web plugins
refreshWebPlugin PUT /api/2.0/settings/webplugins/{name}/refresh Refresh a web plugin
updateWebPlugin PUT /api/2.0/settings/webplugins/{name} Update a web plugin
ThirdParty
Method HTTP request Description
ThirdPartyApi
getThirdPartyCode GET /api/2.0/thirdparty/{provider} Get provider consent URL

Documentation for Models

Models list

Author

support@onlyoffice.com

About

A simple PHP SDK for integrating with the ONLYOFFICE DocSpace API

Topics

docspaceintegrationonlyofficesdk

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

Contributors

Languages