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 string

Exts image previewed

extsMediaPreviewedarray of string

Exts media previewed

extsWebPreviewedarray of string

Exts web previewed

extsWebEditedarray of string

Exts web edited

extsWebEncryptarray of string

Exts web encrypt

extsWebReviewedarray of string

Exts web reviewed

extsWebCustomFilterEditingarray of string

Exts web custom filter editing

extsWebRestrictedEditingarray of string

Exts web restricted editing

extsWebCommentedarray of string

Exts web commented

extsWebTemplatearray of string

Exts web template

extsCoAuthoringarray of string

Exts co authoring

extsMustConvertarray of string

Exts must convert

extsConvertibleobject

Exts convertible

extsUploadablearray of string

Exts uploadable

extsArchivearray of string

Exts archive

extsVideoarray of string

Exts video

extsAudioarray of string

Exts audio

extsImagearray of string

Exts image

extsSpreadsheetarray of string

Exts spreadsheet

extsPresentationarray of string

Exts presentation

extsDocumentarray of string

Exts document

internalFormatsobject

Internal formats

Unknownstring
Archivestring
Videostring
Audiostring
Imagestring
Spreadsheetstring
Presentationstring
Documentstring
Pdfstring
masterFormExtensionstring

Master form extension

paramVersionstring

Param version

paramOutTypestring

Param out type

fileDownloadUrlStringstringformat: uri

File download url string

fileWebViewerUrlStringstring

File web viewer url string

fileWebViewerExternalUrlStringstringformat: uri

File web viewer external url string

fileWebEditorUrlStringstring

File web editor url string

fileWebEditorExternalUrlStringstringformat: uri

File web editor external url string

fileRedirectPreviewUrlStringstringformat: uri

File redirect preview url string

fileThumbnailUrlStringstringformat: uri

File thumbnail url string

confirmDeleteboolean

Confirm delete

enableThirdPartyboolean

EnableT third party

externalShareboolean

External share

externalShareSocialMediaboolean

External share social media

storeOriginalFilesboolean

Store original files

keepNewFileNameboolean

Keep new file name

displayFileExtensionboolean

Display file extension

convertNotifyboolean

Convert notify

hideConfirmConvertSaveboolean

HideC confirm convert save

hideConfirmConvertOpenboolean

Hide confirm convert open

defaultOrderobject
is_ascboolean

Is asc

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

Forcesave

storeForcesaveboolean

Store forcesave

recentSectionboolean

Recent section

favoritesSectionboolean

Favorites section

templatesSectionboolean

Templates section

downloadTarGzboolean

Download tar gz

automaticallyCleanUpobject
isAutoCleanUpboolean

Specifies if the auto-clearing setting is enabled or not

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

Can search by content

defaultSharingAccessRightsarray of any of

Default sharing access rights

.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, RoomManager - Room manager, Editing - Editing, ContentCreator - Content creator]

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

.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 manager, 10 - Editing, 11 - Content creator]

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

maxUploadThreadCountintegerformat: int32

Max upload thread count

chunkUploadSizeintegerformat: int64

Chunk upload size

openEditorInSameTabboolean

Open editor in same tab

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).