summaryrefslogtreecommitdiff
path: root/docs/development/API/admin_api.md
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2021-12-27 18:01:25 -0600
committerAlex Gleason <alex@alexgleason.me>2021-12-27 18:01:25 -0600
commitf5c3d45120364681b3601baa36a0ce9fa22680d7 (patch)
tree5f1379ca293a001111585849521615d69880b7cb /docs/development/API/admin_api.md
parent3117c6099733207b7f2a777f8cb8b5b3b839ebe8 (diff)
parent264f0fde1b9f0cbaf7679eeb59938eb9ca653779 (diff)
downloadpleroma-f5c3d45120364681b3601baa36a0ce9fa22680d7.tar.gz
pleroma-f5c3d45120364681b3601baa36a0ce9fa22680d7.zip
Merge remote-tracking branch 'origin/develop' into apps-api-endpoint
Diffstat (limited to 'docs/development/API/admin_api.md')
-rw-r--r--docs/development/API/admin_api.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
index 8f855d251..f14081893 100644
--- a/docs/development/API/admin_api.md
+++ b/docs/development/API/admin_api.md
@@ -261,6 +261,46 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
+## `PATCH /api/v1/pleroma/admin/users/suggest`
+
+### Suggest a user
+
+Adds the user(s) to follower recommendations.
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
+## `PATCH /api/v1/pleroma/admin/users/unsuggest`
+
+### Unsuggest a user
+
+Removes the user(s) from follower recommendations.
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
## `GET /api/v1/pleroma/admin/users/:nickname_or_id`
### Retrive the details of a user
@@ -319,6 +359,22 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
+## `DELETE /api/v1/pleroma/admin/instances/:instance`
+
+### Delete all users and activities from a remote instance
+
+Note: this will trigger a job to remove instance content in the background.
+It may take some time.
+
+- Params:
+ - `instance`: remote instance host
+- Response:
+ - The `instance` name as a string
+
+```json
+"lain.com"
+```
+
## `GET /api/v1/pleroma/admin/statuses`
### Retrives all latest statuses