diff options
| author | Mark Felder <feld@FreeBSD.org> | 2020-02-18 09:06:27 -0600 |
|---|---|---|
| committer | Mark Felder <feld@FreeBSD.org> | 2020-02-18 09:06:27 -0600 |
| commit | cf943492878c901cf2f0056ee2a8814e0322e9d8 (patch) | |
| tree | 3ae91feb1a78eba87b627e216c035956bdba8853 /docs/API | |
| parent | 514c899275a32e6ef63305f9424c50344d41b12e (diff) | |
| parent | cf8307e71c3f68bc26a540783a3ca26766b3b56c (diff) | |
| download | pleroma-cf943492878c901cf2f0056ee2a8814e0322e9d8.tar.gz | |
Merge branch 'develop' into gun
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/admin_api.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index cd8123c5d..4a448c1a5 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -682,6 +682,8 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ### Get list of merged default settings with saved in database. +*If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.* + **Only works when configuration from database is enabled.** - Params: @@ -692,20 +694,24 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ```json { - configs: [ + "configs": [ { "group": ":pleroma", "key": "Pleroma.Upload", "value": [] } - ] + ], + "need_reboot": true } ``` + need_reboot - *optional*, if were changed reboot time settings. ## `POST /api/pleroma/admin/config` ### Update config settings +*If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.* + **Only works when configuration from database is enabled.** Some modifications are necessary to save the config settings correctly: @@ -795,7 +801,7 @@ config :quack, ``` ```json { - configs: [ + "configs": [ {"group": ":quack", "key": ":level", "value": ":debug"}, {"group": ":quack", "key": ":meta", "value": [":all"]}, ... @@ -806,7 +812,7 @@ config :quack, ```json { - configs: [ + "configs": [ { "group": ":pleroma", "key": "Pleroma.Upload", @@ -838,15 +844,17 @@ config :quack, - 400 Bad Request `"To use this endpoint you need to enable configuration from database."` ```json { - configs: [ + "configs": [ { "group": ":pleroma", "key": "Pleroma.Upload", "value": [...] } - ] + ], + "need_reboot": true } ``` +need_reboot - *optional*, if were changed reboot time settings. ## ` GET /api/pleroma/admin/config/descriptions` |