diff options
author | lain <lain@soykaf.club> | 2020-06-20 09:33:18 +0000 |
---|---|---|
committer | lain <lain@soykaf.club> | 2020-06-20 09:33:18 +0000 |
commit | 7d542450b13742c6efa93246c172c8306e730d50 (patch) | |
tree | 86998336bba747f1ce605a1c06e39ac96f38b396 /docs/API/admin_api.md | |
parent | 4733f6a3371504ebb3eeb447d7c20d56c10b43bf (diff) | |
parent | f9282677731cca96a1316e2830507837535c06e0 (diff) | |
download | pleroma-7d542450b13742c6efa93246c172c8306e730d50.tar.gz |
Merge branch 'develop' into '1865-media-only'
# Conflicts:
# CHANGELOG.md
Diffstat (limited to 'docs/API/admin_api.md')
-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" + ] +} + +``` |