Get the portal settings

GET /api/2.0/settings

Request

Returns a list of all the available portal settings with the current values for each parameter.

Headers

Acceptenum of string

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

Query

withpasswordboolean

Specifies if the password hasher settings will be returned or not

Examples

GET /api/2.0/settings?withpassword=true HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/settings?withpassword=true' \
  --header 'Accept: application/json'

Responses

200

Settings

timezonestring

Time zone

trustedDomainsarray of string

List of trusted domains

trustedDomainsTypeone of

.enum of string

[None - None, Custom - Custom, All - All]

Can be one of: None, Custom, All.

.enum of integer

[0 - None, 1 - Custom, 2 - All]

Can be one of: 0, 1, 2.

culturestring

Language

utcOffsetstringformat: date-span

UTC offset

utcHoursOffsetnumberformat: double

UTC hours offset

greetingSettingsstring

Greeting settings

ownerIdstringformat: uuid

Owner ID

nameSchemaIdstring

Team template ID

enabledJoinboolean

Specifies if a user can join to the portal or not

enableAdmMessboolean

Specifies if a user can send a message to the administrator or not

thirdpartyEnableboolean

Specifies if a user can connect third-party providers or not

docSpaceboolean

Specifies if this is a DocSpace portal or not

standaloneboolean

Specifies if this is a standalone portal or not

isAmiboolean

Specifies if this is a AMI instance or not

baseDomainstring

Base domain

wizardTokenstring

Wizard token

passwordHashobject

sizeintegerformat: int32

iterationsintegerformat: int32

saltstring

firebaseobject

apiKeystring

API key

authDomainstring

Authentication domain

projectIdstring

Project ID

storageBucketstring

Storage bucket

messagingSenderIdstring

Message sender ID

appIdstring

Application ID

measurementIdstring

Measurement ID

databaseURLstring

Database URL

versionstring

Version

recaptchaTypeone of

.enum of string

[Default - Default, AndroidV2 - AndroidV2, iOSV2 - iOSV2, hCaptcha - hCaptcha]

Can be one of: Default, AndroidV2, iOSV2, hCaptcha.

.enum of integer

[0 - Default, 1 - AndroidV2, 2 - iOSV2, 3 - hCaptcha]

Can be one of: 0, 1, 2, 3.

recaptchaPublicKeystring

ReCAPTCHA public key

debugInfoboolean

Specifies if the debug information will be sent or not

socketUrlstring

Socket URL

tenantStatusone of

.enum of string

[Active - Active, Suspended - Suspended, RemovePending - Remove pending, Transfering - Transfering, Restoring - Restoring, Migrating - Migrating, Encryption - Encryption]

Can be one of: Active, Suspended, RemovePending, Transfering, Restoring, Migrating, Encryption.

.enum of integer

[0 - Active, 1 - Suspended, 2 - Remove pending, 3 - Transfering, 4 - Restoring, 5 - Migrating, 6 - Encryption]

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

tenantAliasstring

Tenant alias

helpLinkstring

Link to the help

forumLinkstring

Link to the forum

displayAboutboolean

Specifies whether to display the About section

apiDocsLinkstring

API documentation link

domainValidatorobject

regexstring

Regex

minLengthintegerformat: int32

Min length

maxLengthintegerformat: int32

Max length

zendeskKeystring

Zendesk key

tagManagerIdstring

Tag manager ID

bookTrainingEmailstring

Email for training booking

documentationEmailstring

Documentation email

legalTermsstring

Legal terms

licenseUrlstring

License url

cookieSettingsEnabledboolean

Specifies whether the cookie settings are enabled

limitedAccessSpaceboolean

Limited access space

userNameRegexstring

User name validation regex

invitationLimitintegerformat: int32

Invitation limit

pluginsobject

enabledboolean

Specifies if the plugins are enabled or not

uploadboolean

Specifies if the plugins can be uploaded or not

deleteboolean

Specifies if the plugins can be deleted or not

deepLinkobject

androidPackageNamestring

Android package name

urlstring

Url

iosPackageIdstring

Ios package id

formGalleryobject

pathstring

Path

domainstring

Domain

extstring

Ext

uploadPathstring

Upload path

uploadDomainstring

Upload domain

uploadExtstring

Upload ext

uploadDashboardstring

Upload dashboard

maxImageUploadSizeintegerformat: int64

Max image upload size