diff options
| author | rinpatch <rinpatch@sdf.org> | 2020-05-02 16:22:21 +0000 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2020-05-02 16:22:21 +0000 |
| commit | 019a192e43c2421c74e5126e753aac095db8ad54 (patch) | |
| tree | 3415b92ed0cb9e59f39946a1439fd918c6ea07ee /docs/API | |
| parent | 3b15a0eecc62f79465620a697f12b576ed87b0fc (diff) | |
| parent | 04f23294d327f044a72ecd3f269846c2f6198cf1 (diff) | |
| download | pleroma-2.0.3.tar.gz | |
Merge branch 'release/2.0.3' into 'stable'v2.0.3
Release/2.0.3
See merge request pleroma/secteam/pleroma!3
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/admin_api.md | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index edcf73e14..26f3b1932 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -773,6 +773,8 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ### Restarts pleroma application +**Only works when configuration from database is enabled.** + - Params: none - Response: - On failure: @@ -782,11 +784,24 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret {} ``` +## `GET /api/pleroma/admin/need_reboot` + +### Returns the flag whether the pleroma should be restarted + +- Params: none +- Response: + - `need_reboot` - boolean +```json +{ + "need_reboot": false +} +``` + ## `GET /api/pleroma/admin/config` ### 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.* +*If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.* **Only works when configuration from database is enabled.** @@ -808,13 +823,12 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret "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.* +*If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.* **Only works when configuration from database is enabled.** @@ -956,7 +970,6 @@ config :quack, "need_reboot": true } ``` -need_reboot - *optional*, if were changed reboot time settings. ## ` GET /api/pleroma/admin/config/descriptions` |