diff options
author | Roman Chvanikov <chvanikoff@pm.me> | 2020-06-20 18:47:10 +0300 |
---|---|---|
committer | Roman Chvanikov <chvanikoff@pm.me> | 2020-06-20 18:47:10 +0300 |
commit | fb8775538bf4b6e0f705d29dba016d592d395ace (patch) | |
tree | 9a27aba4b9d79df6e4143acba8ac2994e721519b /docs/API | |
parent | ae48af590507aff8b58429ee7bae70da26d2c4d8 (diff) | |
parent | 31761340fe7246ea9b57c0d0f7e61df85aa2af85 (diff) | |
download | pleroma-fb8775538bf4b6e0f705d29dba016d592d395ace.tar.gz |
Merge branch 'develop' into refactor/fe-bundles
Diffstat (limited to 'docs/API')
-rw-r--r-- | docs/API/admin_api.md | 64 |
1 files changed, 63 insertions, 1 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index 92816baf9..c7f56cf5f 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -1224,4 +1224,66 @@ Loads json generated from `config/descriptions.exs`. - Response: - On success: `204`, empty response - On failure: - - 400 Bad Request `"Invalid parameters"` when `status` is missing
\ No newline at end of file + - 400 Bad Request `"Invalid parameters"` when `status` is missing + +## `GET /api/pleroma/admin/media_proxy_caches` + +### Get a list of all banned MediaProxy URLs in Cachex + +- Authentication: required +- Params: +- *optional* `page`: **integer** page number +- *optional* `page_size`: **integer** number of log entries per page (default is `50`) + +- Response: + +``` json +{ + "urls": [ + "http://example.com/media/a688346.jpg", + "http://example.com/media/fb1f4d.jpg" + ] +} + +``` + +## `POST /api/pleroma/admin/media_proxy_caches/delete` + +### Remove a banned MediaProxy URL from Cachex + +- Authentication: required +- Params: + - `urls` (array) + +- Response: + +``` json +{ + "urls": [ + "http://example.com/media/a688346.jpg", + "http://example.com/media/fb1f4d.jpg" + ] +} + +``` + +## `POST /api/pleroma/admin/media_proxy_caches/purge` + +### Purge a MediaProxy URL + +- Authentication: required +- Params: + - `urls` (array) + - `ban` (boolean) + +- Response: + +``` json +{ + "urls": [ + "http://example.com/media/a688346.jpg", + "http://example.com/media/fb1f4d.jpg" + ] +} + +``` |