diff options
| author | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2020-04-17 08:55:46 +0000 |
|---|---|---|
| committer | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2020-04-17 08:55:46 +0000 |
| commit | 9c76d70a4766382abb10a81707b408a8999b97d2 (patch) | |
| tree | 8032566992eaaa0f9a92a80c8d5e46e78e5fd2e1 /docs/API/admin_api.md | |
| parent | badd888ccbeed88228c0de66c068812a49139ce3 (diff) | |
| parent | 72ef6cc4f2f601e26ba84c16ad2c91bd72867629 (diff) | |
| download | pleroma-9c76d70a4766382abb10a81707b408a8999b97d2.tar.gz | |
Merge branch 'feature/1677-need_reboot-flag-endpoint' into 'develop'
Added need_reboot endpoint to admin api
Closes #1677
See merge request pleroma/pleroma!2373
Diffstat (limited to 'docs/API/admin_api.md')
| -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 57fb6bc6a..0ba88470a 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -786,6 +786,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: @@ -795,11 +797,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.** @@ -821,13 +836,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.** @@ -971,7 +985,6 @@ config :quack, "need_reboot": true } ``` -need_reboot - *optional*, if were changed reboot time settings. ## ` GET /api/pleroma/admin/config/descriptions` |