summaryrefslogtreecommitdiff
path: root/docs/API/admin_api.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/API/admin_api.md')
-rw-r--r--docs/API/admin_api.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index 07aa7ec3f..47acd240e 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -665,11 +665,9 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
- 404 Not Found `"Not found"`
- On success: 200 OK `{}`
-## `GET /api/pleroma/admin/config/migrate_from_db`
+## `GET /api/pleroma/admin/restart`
-### Run mix task pleroma.config migrate_from_db
-
-Copies all settings from database to `config/{env}.exported_from_db.secret.exs` with deletion from the table. Where `{env}` is the environment in which `pleroma` is running.
+### Restarts pleroma application
- Params: none
- Response:
@@ -684,6 +682,8 @@ Copies all settings from database to `config/{env}.exported_from_db.secret.exs`
### 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:
@@ -691,24 +691,27 @@ Copies all settings from database to `config/{env}.exported_from_db.secret.exs`
- Response:
- On failure:
- 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
- - 400 Bad Request `"To use configuration from database migrate your settings to database."`
```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:
@@ -796,7 +799,7 @@ config :quack,
```
```json
{
- configs: [
+ "configs": [
{"group": ":quack", "key": ":level", "value": ":debug"},
{"group": ":quack", "key": ":meta", "value": [":all"]},
...
@@ -807,7 +810,7 @@ config :quack,
```json
{
- configs: [
+ "configs": [
{
"group": ":pleroma",
"key": "Pleroma.Upload",
@@ -839,15 +842,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`