Get Public Settings

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Retrieve all public settings.

Method	Requires Auth
`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 timestamps.

Example call to retrieve all settings

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

Example 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 } ]
}

Example 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": []
    }
}

Was this article helpful?

What's Next

Check Username Availability

On this page

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