Merge branch 'v2-suggestions' into 'develop'

[akkoma] / docs / development / API / admin_api.md

diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
index 79531c45b6e40c252228594be55dd2ffbc36f8b2..f140818934a05fe41761a9f65ce92d4765357e18 100644 (file)
--- a/docs/development/API/admin_api.md
+++ b/docs/development/API/admin_api.md
@@ -359,6 +359,22 @@ Removes the user(s) from follower recommendations.
 }
 ```
 
+## `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