Links
Comment on page

Get Public Settings

Retrieve all public settings.
Name
Requires Auth
Permission
Setting
public-settings/get
Yes

Payload Parameters

Argument
Example
Required
Description
date
{ "$date": 1480377601 }
Optional
Filters the results to contain the updated and removed settings after the provided time. It accepts timestamp.

Example call to retrieve all settings

{
"msg": "method",
"method": "public-settings/get",
"id": "42"
}

Response

{
"msg": "result",
"id": "42",
"result": [
{
"_id": "FileUpload_Enabled",
"value": true,
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_MaxFileSize",
"value": 104857600,
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_MediaTypeWhiteList",
"value": "",
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_MediaTypeBlackList",
"value": "image/svg+xml",
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_ProtectFiles",
"value": true,
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_RotateImages",
"value": true,
"enterprise": false,
"requiredOnWizard": false
},
}

Example call to retrieve the updated and removed settings since the provided date

{
"msg": "method",
"method": "public-settings/get",
"id": "42",
"params": [ { "$date": 1480377601 } ]
}

Response

"result": {
"update": [
{
"_id": "FileUpload_Enabled",
"value": true,
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_MaxFileSize",
"value": 104857600,
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_MediaTypeWhiteList",
"value": "",
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_MediaTypeBlackList",
"value": "image/svg+xml",
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_ProtectFiles",
"value": true,
"enterprise": false,
"requiredOnWizard": false
},
{
"_id": "FileUpload_RotateImages",
"value": true,
"enterprise": false,
"requiredOnWizard": false
}
],
"remove": []
}
}
Last modified 5mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.