diff options
| author | lain <lain@soykaf.club> | 2021-11-15 14:24:13 +0000 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2021-11-15 14:24:13 +0000 |
| commit | 6e3df116935a549a92b74bfc2be9a4197ad7a995 (patch) | |
| tree | 03f0dbb4a37ea7432f64e2587849142f29c3a6f2 /docs | |
| parent | 6aff3d320478df678aeda9bc58b9d4e4b3afbf75 (diff) | |
| parent | c4efe0d2d62763b1163d734c20f19876b1b66865 (diff) | |
Merge branch 'instance-deletion' into 'develop'
AdminAPI: endpoint to delete all content from a remote instance
See merge request pleroma/pleroma!3483
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/API/admin_api.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md index 8f855d251..82483fae7 100644 --- a/docs/development/API/admin_api.md +++ b/docs/development/API/admin_api.md @@ -319,6 +319,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 |