diff options
author | Maksim Pechnikov <parallel588@gmail.com> | 2020-06-15 15:24:00 +0300 |
---|---|---|
committer | Maksim Pechnikov <parallel588@gmail.com> | 2020-06-15 15:24:00 +0300 |
commit | efdfc85c2d8e5118c1aa18e4f04026ec90cd11d2 (patch) | |
tree | f70008358f5680e754fc09cdf022a7acfb52e851 | |
parent | 62b8c31b7a84dadb2a46861fe0f2dd1dbf9d40f0 (diff) | |
download | pleroma-efdfc85c2d8e5118c1aa18e4f04026ec90cd11d2.tar.gz pleroma-efdfc85c2d8e5118c1aa18e4f04026ec90cd11d2.zip |
update docs
-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..6659b605d 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` + +- 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` + - `ban` + +- Response: + +``` json +{ + "urls": [ + "http://example.com/media/a688346.jpg", + "http://example.com/media/fb1f4d.jpg" + ] +} + +``` |