summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2021-07-17 14:55:05 -0500
committerAlex Gleason <alex@alexgleason.me>2021-07-17 14:55:05 -0500
commit54dbcfe02a05a75d7fe7591335df74743930182d (patch)
tree1bda3dc445d305c3e0ac540c33398f682ccae0d5 /docs
parentf67d00d12b5d66a960bd7b3822a5fa4418348e18 (diff)
AdminAPI: add DELETE /instances/:instance to delete all content from a remote instance
Diffstat (limited to 'docs')
-rw-r--r--docs/development/API/admin_api.md16
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