Get file settings
GET /api/2.0/files/settings
Request
Returns all the file settings.
Headers
- Accept
enum 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
- extsImagePreviewed
array of string
Exts image previewed
- extsMediaPreviewed
array of string
Exts media previewed
- extsWebPreviewed
array of string
Exts web previewed
- extsWebEdited
array of string
Exts web edited
- extsWebEncrypt
array of string
Exts web encrypt
- extsWebReviewed
array of string
Exts web reviewed
- extsWebCustomFilterEditing
array of string
Exts web custom filter editing
- extsWebRestrictedEditing
array of string
Exts web restricted editing
- extsWebCommented
array of string
Exts web commented
- extsWebTemplate
array of string
Exts web template
- extsCoAuthoring
array of string
Exts co authoring
- extsMustConvert
array of string
Exts must convert
- extsConvertible
object
Exts convertible
- extsUploadable
array of string
Exts uploadable
- extsArchive
array of string
Exts archive
- extsVideo
array of string
Exts video
- extsAudio
array of string
Exts audio
- extsImage
array of string
Exts image
- extsSpreadsheet
array of string
Exts spreadsheet
- extsPresentation
array of string
Exts presentation
- extsDocument
array of string
Exts document
- internalFormats
object
Internal formats
- Unknown
string
- Archive
string
- Video
string
- Audio
string
- Image
string
- Spreadsheet
string
- Presentation
string
- Document
string
- Pdf
string
- masterFormExtension
string
Master form extension
- paramVersion
string
Param version
- paramOutType
string
Param out type
- fileDownloadUrlString
string
uri File download url string
- fileWebViewerUrlString
string
File web viewer url string
- fileWebViewerExternalUrlString
string
uri File web viewer external url string
- fileWebEditorUrlString
string
File web editor url string
- fileWebEditorExternalUrlString
string
uri File web editor external url string
- fileRedirectPreviewUrlString
string
uri File redirect preview url string
- fileThumbnailUrlString
string
uri File thumbnail url string
- confirmDelete
boolean
Confirm delete
- enableThirdParty
boolean
EnableT third party
- externalShare
boolean
External share
- externalShareSocialMedia
boolean
External share social media
- storeOriginalFiles
boolean
Store original files
- keepNewFileName
boolean
Keep new file name
- displayFileExtension
boolean
Display file extension
- convertNotify
boolean
Convert notify
- hideConfirmConvertSave
boolean
HideC confirm convert save
- hideConfirmConvertOpen
boolean
Hide confirm convert open
- defaultOrder
object
- is_asc
boolean
Is asc
- property
one 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
.
- forcesave
boolean
Forcesave
- storeForcesave
boolean
Store forcesave
- recentSection
boolean
Recent section
- favoritesSection
boolean
Favorites section
- templatesSection
boolean
Templates section
- downloadTarGz
boolean
Download tar gz
- automaticallyCleanUp
object
- isAutoCleanUp
boolean
Specifies if the auto-clearing setting is enabled or not
- gap
one 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
.
- canSearchByContent
boolean
Can search by content
- defaultSharingAccessRights
array 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
.
- maxUploadThreadCount
integer
int32 Max upload thread count
- chunkUploadSize
integer
int64 Chunk upload size
- openEditorInSameTab
boolean
Open editor in same tab