ONLYOFFICE DocSpace Files API

The browsable version of this reference, with a request builder and code samples, is published at https://api.onlyoffice.com/docspace/api-backend/usage-api/.

All URIs are relative to https://yourportal.onlyoffice.com, where the host is the address of your DocSpace instance.

Files

Method	HTTP request	Description
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

Folders

Method	HTTP request	Description
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

Metadata

Method	HTTP request	Description
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
updateTemplate	PUT /api/2.0/files/metadata/templates/{templateId}	Update a metadata template

Operations

Method	HTTP request	Description
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

Quota

Method	HTTP request	Description
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

Settings

Method	HTTP request	Description
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

Sharing

Method	HTTP request	Description
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

Third-party integration

Method	HTTP request	Description
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

Authorization

cookieAuth

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

bearerAuth

• Type: HTTP Bearer Token authentication

asc_auth_key

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

Basic

• Type: HTTP basic authentication

Bearer

• Type: HTTP Bearer Token authentication (JWT)

ApiKeyBearer

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

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

x-signature

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