diff options
author | Alex Gleason <alex@alexgleason.me> | 2021-12-19 12:55:36 -0600 |
---|---|---|
committer | Alex Gleason <alex@alexgleason.me> | 2021-12-19 12:55:36 -0600 |
commit | 3f8fc34593414f6e35925038c38775203333b3f3 (patch) | |
tree | b11c6c15246dbaa8f0cd1d382d6cb762196c2b1b /docs/development/API | |
parent | e311c60923432f30fc4ab7bd37d338d60f40e25f (diff) | |
parent | 50892a198d14a628c37139761b709cd5e3261a23 (diff) | |
download | pleroma-3f8fc34593414f6e35925038c38775203333b3f3.tar.gz pleroma-3f8fc34593414f6e35925038c38775203333b3f3.zip |
Merge remote-tracking branch 'origin/develop' into moderators
Diffstat (limited to 'docs/development/API')
-rw-r--r-- | docs/development/API/admin_api.md | 56 |
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 |