Get file settings

GET /api/2.0/files/settings

Request

Returns all the file settings.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/files/settings HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/files/settings \
  --header 'Accept: application/json'

Responses

200

File settings

extsImagePreviewedarray of unknown
extsMediaPreviewedarray of unknown
extsWebPreviewedarray of unknown
extsWebEditedarray of unknown
extsWebEncryptarray of unknown
extsWebReviewedarray of unknown
extsWebCustomFilterEditingarray of unknown
extsWebRestrictedEditingarray of unknown
extsWebCommentedarray of unknown
extsWebTemplatearray of unknown
extsCoAuthoringarray of unknown
extsMustConvertarray of unknown
extsConvertibleobject
extsUploadablearray of unknown
extsArchivearray of unknown
extsVideoarray of unknown
extsAudioarray of unknown
extsImagearray of unknown
extsSpreadsheetarray of unknown
extsPresentationarray of unknown
extsDocumentarray of unknown
internalFormatsobject
Unknownstring
Archivestring
Videostring
Audiostring
Imagestring
Spreadsheetstring
Presentationstring
Documentstring
Pdfstring
masterFormExtensionstring
paramVersionstring
paramOutTypestring
fileDownloadUrlStringstringformat: uri
fileWebViewerUrlStringstring
fileWebViewerExternalUrlStringstringformat: uri
fileWebEditorUrlStringstring
fileWebEditorExternalUrlStringstringformat: uri
fileRedirectPreviewUrlStringstringformat: uri
fileThumbnailUrlStringstringformat: uri
confirmDeleteboolean
enableThirdPartyboolean
externalShareboolean
externalShareSocialMediaboolean
storeOriginalFilesboolean
keepNewFileNameboolean
convertNotifyboolean
hideConfirmConvertSaveboolean
hideConfirmConvertOpenboolean
defaultOrderobject
is_ascboolean
propertyone of
.enum of string

[DateAndTime - Date and time, AZ - AZ, Size - Size, Author - Author, Type - Type, New - New, DateAndTimeCreation - Date and time creation, RoomType - Room type, Tags - Tags, Room - Room, CustomOrder - Custom order, LastOpened - Last opened, UsedSpace - Used space]

Can be one of: DateAndTime, AZ, Size, Author, Type, New, DateAndTimeCreation, RoomType, Tags, Room, CustomOrder, LastOpened, UsedSpace.

.enum of integer

[0 - Date and time, 1 - AZ, 2 - Size, 3 - Author, 4 - Type, 5 - New, 6 - Date and time creation, 7 - Room type, 8 - Tags, 9 - Room, 10 - Custom order, 11 - Last opened, 12 - Used space]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12.

forcesaveboolean
storeForcesaveboolean
recentSectionboolean
favoritesSectionboolean
templatesSectionboolean
downloadTarGzboolean
automaticallyCleanUpobject
isAutoCleanUpboolean
gapone of
.enum of string

[OneWeek - One week, TwoWeeks - Two weeks, OneMonth - One month, ThirtyDays - Thirty days, TwoMonths - Two months, ThreeMonths - Three months]

Can be one of: OneWeek, TwoWeeks, OneMonth, ThirtyDays, TwoMonths, ThreeMonths.

.enum of integer

[1 - One week, 2 - Two weeks, 3 - One month, 4 - Thirty days, 5 - Two months, 6 - Three months]

Can be one of: 1, 2, 3, 4, 5, 6.

canSearchByContentboolean
defaultSharingAccessRightsarray of any of
.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomAdmin, Editing, PowerUser.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room admin, 10 - Editing, 11 - Power user]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

maxUploadThreadCountintegerformat: int32
chunkUploadSizeintegerformat: int64
openEditorInSameTabboolean

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).