summaryrefslogtreecommitdiff
path: root/docs/development/API
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2021-12-15 19:05:36 -0500
committerAlex Gleason <alex@alexgleason.me>2021-12-15 19:05:36 -0500
commite1b89fe3aa2c03576a6f2418c1e83c0ed64707a3 (patch)
tree6a8b31ef3612c4f8f5b405361c7cb875f4661d84 /docs/development/API
parent29d80b39f287ed2488a612280d41e9dd2e40a7cc (diff)
parent6eb7d69e60a96e577de92de232ed48e509f23cd4 (diff)
downloadpleroma-e1b89fe3aa2c03576a6f2418c1e83c0ed64707a3.tar.gz
pleroma-e1b89fe3aa2c03576a6f2418c1e83c0ed64707a3.zip
Merge remote-tracking branch 'origin/develop' into live-dashboard
Diffstat (limited to 'docs/development/API')
-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