GET api/2.0/settings
Returns a list of all the available portal settings with the current values for each parameter.
Name |
Description |
Type |
Example |
withpassword
sent in body
|
Specifies if the password hasher settings will be returned or not
optional
|
Bool value
|
true
|
GET api/2.0/settings
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"withpassword": true
}
application/json
{
"status": 0,
"response": {
"Timezone": "some text",
"TrustedDomains": [
"some text"
],
"TrustedDomainsType": "None",
"Culture": "some text",
"GreetingSettings": "some text",
"OwnerId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
"NameSchemaId": "some text",
"Personal": true,
"DocSpace": true,
"Standalone": true,
"BaseDomain": "some text",
"WizardToken": "some text",
"Firebase": {
"ApiKey": "some text",
"AuthDomain": "some text",
"ProjectId": "some text",
"StorageBucket": "some text",
"MessagingSenderId": "some text",
"AppId": "some text",
"MeasurementId": "some text"
},
"Version": "some text",
"RecaptchaPublicKey": "some text",
"DebugInfo": true,
"SocketUrl": "some text",
"TenantAlias": "some text",
"HelpLink": "some text",
"ZendeskKey": "some text",
"BookTrainingEmail": "some text",
"DocumentationEmail": "some text",
"LegalTerms": "some text",
"Plugins": {
"Enabled": true
}
}
}
text/xml
<result>
<status>0</status>
<response>
<Timezone>some text</Timezone>
<TrustedDomains>[
"some text"
]</TrustedDomains>
<TrustedDomainsType>None</TrustedDomainsType>
<Culture>some text</Culture>
<GreetingSettings>some text</GreetingSettings>
<OwnerId>9924256A-739C-462b-AF15-E652A3B1B6EB</OwnerId>
<NameSchemaId>some text</NameSchemaId>
<Personal>True</Personal>
<DocSpace>True</DocSpace>
<Standalone>True</Standalone>
<BaseDomain>some text</BaseDomain>
<WizardToken>some text</WizardToken>
<Firebase>
<ApiKey>some text</ApiKey>
<AuthDomain>some text</AuthDomain>
<ProjectId>some text</ProjectId>
<StorageBucket>some text</StorageBucket>
<MessagingSenderId>some text</MessagingSenderId>
<AppId>some text</AppId>
<MeasurementId>some text</MeasurementId>
</Firebase>
<Version>some text</Version>
<RecaptchaPublicKey>some text</RecaptchaPublicKey>
<DebugInfo>True</DebugInfo>
<SocketUrl>some text</SocketUrl>
<TenantAlias>some text</TenantAlias>
<HelpLink>some text</HelpLink>
<ZendeskKey>some text</ZendeskKey>
<BookTrainingEmail>some text</BookTrainingEmail>
<DocumentationEmail>some text</DocumentationEmail>
<LegalTerms>some text</LegalTerms>
<Plugins>
<Enabled>True</Enabled>
</Plugins>
</response>
</result>