3 Authentication is required and the user must be an admin.
7 * `[:auth, :enforce_oauth_admin_scope_usage]` — OAuth admin scope requirement toggle.
8 If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token (client app must support admin scopes).
9 If `false` and token doesn't have admin scope(s), `is_admin` user flag grants access to admin-specific actions.
10 Note that client app needs to explicitly support admin scopes and request them when obtaining auth token.
12 ## `GET /api/pleroma/admin/users`
17 - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)
18 - *optional* `filters`: **string** comma-separated string of filters:
19 - `local`: only local users
20 - `external`: only external users
21 - `active`: only active users
22 - `need_approval`: only unapproved users
23 - `unconfirmed`: only unconfirmed users
24 - `deactivated`: only deactivated users
25 - `is_admin`: users with admin role
26 - `is_moderator`: users with moderator role
27 - *optional* `page`: **integer** page number
28 - *optional* `page_size`: **integer** number of users per page (default is `50`)
29 - *optional* `tags`: **[string]** tags list
30 - *optional* `actor_types`: **[string]** actor type list (`Person`, `Service`, `Application`)
31 - *optional* `name`: **string** user display name
32 - *optional* `email`: **string** user email
33 - Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10&tags[]=some_tag&tags[]=another_tag&name=display_name&email=email@example.com`
52 "display_name": string,
53 "confirmation_pending": bool,
54 "approval_pending": bool,
55 "registration_reason": string,
62 ## DEPRECATED `DELETE /api/pleroma/admin/users`
68 - Response: User’s nickname
70 ## `DELETE /api/pleroma/admin/users`
76 - Response: Array of user nicknames
89 - Response: User’s nickname
91 ## `POST /api/pleroma/admin/users/follow`
93 ### Make a user follow another user
96 - `follower`: The nickname of the follower
97 - `followed`: The nickname of the followed
101 ## `POST /api/pleroma/admin/users/unfollow`
103 ### Make a user unfollow another user
106 - `follower`: The nickname of the follower
107 - `followed`: The nickname of the followed
111 ## `PATCH /api/pleroma/admin/users/:nickname/toggle_activation`
113 ### Toggle user activation
117 - Response: User’s object
127 ## `PUT /api/pleroma/admin/users/tag`
129 ### Tag a list of users
132 - `nicknames` (array)
135 ## `DELETE /api/pleroma/admin/users/tag`
137 ### Untag a list of users
140 - `nicknames` (array)
143 ## `GET /api/pleroma/admin/users/:nickname/permission_group`
145 ### Get user user permission groups membership
152 "is_moderator": bool,
157 ## `GET /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
159 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
161 ### Get user user permission groups membership per permission group
168 "is_moderator": bool,
173 ## DEPRECATED `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
175 ### Add user to permission group
179 - On failure: `{"error": "…"}`
180 - On success: JSON of the user
182 ## `POST /api/pleroma/admin/users/permission_group/:permission_group`
184 ### Add users to permission group
187 - `nicknames`: nicknames array
189 - On failure: `{"error": "…"}`
190 - On success: JSON of the user
192 ## DEPRECATED `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
194 ## `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
196 ### Remove user from permission group
200 - On failure: `{"error": "…"}`
201 - On success: JSON of the user
202 - Note: An admin cannot revoke their own admin status.
204 ## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
206 ### Remove users from permission group
209 - `nicknames`: nicknames array
211 - On failure: `{"error": "…"}`
212 - On success: JSON of the user
213 - Note: An admin cannot revoke their own admin status.
215 ## `PATCH /api/pleroma/admin/users/activate`
220 - `nicknames`: nicknames array
233 ## `PATCH /api/pleroma/admin/users/deactivate`
238 - `nicknames`: nicknames array
251 ## `PATCH /api/pleroma/admin/users/approve`
256 - `nicknames`: nicknames array
269 ## `GET /api/pleroma/admin/users/:nickname_or_id`
271 ### Retrive the details of a user
276 - On failure: `Not found`
277 - On success: JSON of the user
279 ## `GET /api/pleroma/admin/users/:nickname_or_id/statuses`
281 ### Retrive user's latest statuses
285 - *optional* `page_size`: number of statuses to return (default is `20`)
286 - *optional* `godmode`: `true`/`false` – allows to see private statuses
287 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
289 - On failure: `Not found`
290 - On success: JSON array of user's latest statuses
292 ## `GET /api/pleroma/admin/instances/:instance/statuses`
294 ### Retrive instance's latest statuses
297 - `instance`: instance name
298 - *optional* `page_size`: number of statuses to return (default is `20`)
299 - *optional* `godmode`: `true`/`false` – allows to see private statuses
300 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
302 - On failure: `Not found`
303 - On success: JSON array of instance's latest statuses
305 ## `GET /api/pleroma/admin/statuses`
307 ### Retrives all latest statuses
310 - *optional* `page_size`: number of statuses to return (default is `20`)
311 - *optional* `local_only`: excludes remote statuses
312 - *optional* `godmode`: `true`/`false` – allows to see private statuses
313 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
315 - On failure: `Not found`
316 - On success: JSON array of user's latest statuses
318 ## `GET /api/pleroma/admin/relay`
325 * On success: JSON array of relays
329 {"actor": "https://example.com/relay", "followed_back": true},
330 {"actor": "https://example2.com/relay", "followed_back": false}
334 ## `POST /api/pleroma/admin/relay`
344 * On success: relay json object
347 {"actor": "https://example.com/relay", "followed_back": true}
350 ## `DELETE /api/pleroma/admin/relay`
356 - *optional* `force`: forcefully unfollow a relay even when the relay is not available. (default is `false`)
360 * On success: URL of the unfollowed relay
363 {"https://example.com/relay"}
366 ## `POST /api/pleroma/admin/users/invite_token`
368 ### Create an account registration invite token
371 - *optional* `max_use` (integer)
372 - *optional* `expires_at` (date string e.g. "2019-04-07")
383 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
387 ## `GET /api/pleroma/admin/users/invites`
389 ### Get a list of generated invites
405 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
412 ## `POST /api/pleroma/admin/users/revoke_invite`
414 ### Revoke invite by token
428 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
433 ## `POST /api/pleroma/admin/users/email_invite`
435 ### Sends registration invite via email
442 - On success: `204`, empty response
444 - 400 Bad Request, JSON:
449 "error": "Appropriate error message here"
454 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
456 ### Get a password reset token for a given nickname
464 "token": "base64 reset token",
465 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
469 ## `PATCH /api/pleroma/admin/users/force_password_reset`
471 ### Force passord reset for a user with a given nickname
475 - Response: none (code `204`)
477 ## PUT `/api/pleroma/admin/users/disable_mfa`
479 ### Disable mfa for user's account.
483 - Response: User’s nickname
485 ## `GET /api/pleroma/admin/users/:nickname/credentials`
487 ### Get the user's email, password, display and settings-related fields
496 "actor_type": "Person",
497 "allow_following_move": true,
498 "avatar": "https://pleroma.social/media/7e8e7508fd545ef580549b6881d80ec0ff2c81ed9ad37b9bdbbdf0e0d030159d.jpg",
499 "background": "https://pleroma.social/media/4de34c0bd10970d02cbdef8972bef0ebbf55f43cadc449554d4396156162fe9a.jpg",
500 "banner": "https://pleroma.social/media/8d92ba2bd244b613520abf557dd448adcd30f5587022813ee9dd068945986946.jpg",
502 "default_scope": "public",
503 "discoverable": false,
504 "email": "user@example.com",
508 "value": "<a href=\"https://example.com\" rel=\"ugc\">https://example.com</a>"
511 "hide_favorites": false,
512 "hide_followers": false,
513 "hide_followers_count": false,
514 "hide_follows": false,
515 "hide_follows_count": false,
516 "id": "9oouHaEEUR54hls968",
519 "no_rich_text": true,
520 "pleroma_settings_store": {},
525 "value": "https://example.com"
529 "skip_thread_containment": false
533 ## `PATCH /api/pleroma/admin/users/:nickname/credentials`
535 ### Change the user's email, password, display and settings-related fields
549 * `hide_followers_count`
550 * `hide_follows_count`
552 * `allow_following_move`
555 * `skip_thread_containment`
565 {"status": "success"}
572 {"actor_type": "is invalid"},
573 {"email": "has invalid format"},
581 {"error": "Not found"}
584 ## `GET /api/pleroma/admin/reports`
586 ### Get a list of reports
589 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
590 - *optional* `limit`: **integer** the number of records to retrieve
591 - *optional* `page`: **integer** page number
592 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
594 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
595 - On success: JSON, returns a list of reports, where:
596 - `account`: the user who has been reported
597 - `actor`: the user who has sent the report
598 - `statuses`: list of statuses that have been included to the report
607 "avatar": "https://pleroma.example.org/images/avi.png",
608 "avatar_static": "https://pleroma.example.org/images/avi.png",
610 "created_at": "2019-04-23T17:32:04.000Z",
611 "display_name": "User",
614 "followers_count": 1,
615 "following_count": 1,
616 "header": "https://pleroma.example.org/images/banner.png",
617 "header_static": "https://pleroma.example.org/images/banner.png",
618 "id": "9i6dAJqSGSKMzLG2Lo",
622 "confirmation_pending": false,
623 "hide_favorites": true,
624 "hide_followers": false,
625 "hide_follows": false,
627 "is_moderator": false,
636 "tags": ["force_unlisted"],
638 "url": "https://pleroma.example.org/users/user",
643 "avatar": "https://pleroma.example.org/images/avi.png",
644 "avatar_static": "https://pleroma.example.org/images/avi.png",
646 "created_at": "2019-03-28T17:36:03.000Z",
647 "display_name": "Roger Braun",
650 "followers_count": 1,
651 "following_count": 1,
652 "header": "https://pleroma.example.org/images/banner.png",
653 "header_static": "https://pleroma.example.org/images/banner.png",
654 "id": "9hEkA5JsvAdlSrocam",
658 "confirmation_pending": false,
659 "hide_favorites": false,
660 "hide_followers": false,
661 "hide_follows": false,
663 "is_moderator": false,
672 "tags": ["force_unlisted"],
674 "url": "https://pleroma.example.org/users/lain",
677 "content": "Please delete it",
678 "created_at": "2019-04-29T19:48:15.000Z",
679 "id": "9iJGOv1j8hxuw19bcm",
690 "content": "<span class=\"h-card\"><a data-user=\"9hEkA5JsvAdlSrocam\" class=\"u-url mention\" href=\"https://pleroma.example.org/users/lain\">@<span>lain</span></a></span> click on my link <a href=\"https://www.google.com/\">https://www.google.com/</a>",
691 "created_at": "2019-04-23T19:15:47.000Z",
694 "favourites_count": 0,
695 "id": "9i6mQ9uVrrOmOime8m",
696 "in_reply_to_account_id": null,
697 "in_reply_to_id": null,
699 "media_attachments": [],
703 "id": "9hEkA5JsvAdlSrocam",
704 "url": "https://pleroma.example.org/users/lain",
709 "id": "9i6dAJqSGSKMzLG2Lo",
710 "url": "https://pleroma.example.org/users/user",
718 "text/plain": "@lain click on my link https://www.google.com/"
720 "conversation_id": 28,
721 "in_reply_to_account_acct": null,
734 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
735 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
736 "visibility": "direct"
744 ## `GET /api/pleroma/admin/grouped_reports`
746 ### Get a list of reports, grouped by status
749 - On success: JSON, returns a list of reports, where:
750 - `date`: date of the latest report
751 - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
752 - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
753 - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
754 - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
759 "date": "2019-10-07T12:31:39.615149Z",
762 "actors": [{ ... }, { ... }],
768 ## `GET /api/pleroma/admin/reports/:id`
770 ### Get an individual report
776 - 403 Forbidden `{"error": "error_msg"}`
777 - 404 Not Found `"Not found"`
778 - On success: JSON, Report object (see above)
780 ## `PATCH /api/pleroma/admin/reports`
782 ### Change the state of one or multiple reports
789 `id`, // required, report id
790 `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
798 - 400 Bad Request, JSON:
804 `error` // error message
809 - On success: `204`, empty response
811 ## `POST /api/pleroma/admin/reports/:id/notes`
813 ### Create report note
816 - `id`: required, report id
817 - `content`: required, the message
820 - 400 Bad Request `"Invalid parameters"` when `status` is missing
821 - On success: `204`, empty response
823 ## `DELETE /api/pleroma/admin/reports/:report_id/notes/:id`
825 ### Delete report note
828 - `report_id`: required, report id
829 - `id`: required, note id
832 - 400 Bad Request `"Invalid parameters"` when `status` is missing
833 - On success: `204`, empty response
835 ## `GET /api/pleroma/admin/statuses/:id`
837 ### Show status by id
840 - `id`: required, status id
843 - 404 Not Found `"Not Found"`
844 - On success: JSON, Mastodon Status entity
846 ## `PUT /api/pleroma/admin/statuses/:id`
848 ### Change the scope of an individual reported status
852 - `sensitive`: optional, valid values are `true` or `false`
853 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
856 - 400 Bad Request `"Unsupported visibility"`
857 - 403 Forbidden `{"error": "error_msg"}`
858 - 404 Not Found `"Not found"`
859 - On success: JSON, Mastodon Status entity
861 ## `DELETE /api/pleroma/admin/statuses/:id`
863 ### Delete an individual reported status
869 - 403 Forbidden `{"error": "error_msg"}`
870 - 404 Not Found `"Not found"`
871 - On success: 200 OK `{}`
873 ## `GET /api/pleroma/admin/restart`
875 ### Restarts pleroma application
877 **Only works when configuration from database is enabled.**
882 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
888 ## `GET /api/pleroma/admin/need_reboot`
890 ### Returns the flag whether the pleroma should be restarted
894 - `need_reboot` - boolean
901 ## `GET /api/pleroma/admin/config`
903 ### Get list of merged default settings with saved in database.
905 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
907 **Only works when configuration from database is enabled.**
910 - `only_db`: true (*optional*, get only saved in database settings)
913 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
920 "key": "Pleroma.Upload",
928 ## `POST /api/pleroma/admin/config`
930 ### Update config settings
932 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
934 **Only works when configuration from database is enabled.**
936 Some modifications are necessary to save the config settings correctly:
938 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
940 "Pleroma.Upload" -> Pleroma.Upload
943 - strings starting with `:` will be converted to atoms;
945 ":pleroma" -> :pleroma
947 - objects with `tuple` key and array value will be converted to tuples;
949 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
951 - arrays with *tuple objects* will be converted to keywords;
953 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
956 Most of the settings will be applied in `runtime`, this means that you don't need to restart the instance. But some settings are applied in `compile time` and require a reboot of the instance, such as:
957 - all settings inside these keys:
959 - `:connections_pool`
962 - partially settings inside these keys:
963 - `:seconds_valid` in `Pleroma.Captcha`
964 - `:proxy_remote` in `Pleroma.Upload`
965 - `:upload_limit` in `:instance`
968 - `configs` - array of config objects
969 - config object params:
970 - `group` - string (**required**)
971 - `key` - string (**required**)
972 - `value` - string, [], {} or {"tuple": []} (**required**)
973 - `delete` - true (*optional*, if setting must be deleted)
974 - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
976 *When a value have several nested settings, you can delete only some nested settings by passing a parameter `subkeys`, without deleting all settings by key.*
978 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
979 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
980 [subkey2: val2] \\ value after deletion
983 *Most of the settings can be partially updated through merge old values with new values, except settings value of which is list or is not keyword.*
985 Example of setting without keyword in value:
987 config :tesla, :adapter, Tesla.Adapter.Hackney
990 List of settings which support only full update by key:
993 {:pleroma, :ecto_repos},
996 {:cors_plug, [:max_age, :methods, :expose, :headers]},
997 {:auto_linker, :opts},
998 {:swarm, :node_blacklist},
1003 List of settings which support only full update by subkey:
1005 @full_subkey_update [
1006 {:pleroma, :assets, :mascots},
1007 {:pleroma, :emoji, :groups},
1008 {:pleroma, :workers, :retries},
1009 {:pleroma, :mrf_subchain, :match_actor},
1010 {:pleroma, :mrf_keyword, :replace}
1014 *Settings without explicit key must be sended in separate config object params.*
1024 {"group": ":quack", "key": ":level", "value": ":debug"},
1025 {"group": ":quack", "key": ":meta", "value": [":all"]},
1036 "group": ":pleroma",
1037 "key": "Pleroma.Upload",
1039 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
1040 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
1041 {"tuple": [":link_name", true]},
1042 {"tuple": [":proxy_remote", false]},
1043 {"tuple": [":proxy_opts", [
1044 {"tuple": [":redirect_on_failure", false]},
1045 {"tuple": [":max_body_length", 1048576]},
1046 {"tuple": [":http", [
1047 {"tuple": [":follow_redirect", true]},
1048 {"tuple": [":pool", ":upload"]},
1052 {"tuple": [":dispatch", {
1053 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
1063 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
1068 "group": ":pleroma",
1069 "key": "Pleroma.Upload",
1077 ## ` GET /api/pleroma/admin/config/descriptions`
1079 ### Get JSON with config descriptions.
1080 Loads json generated from `config/descriptions.exs`.
1087 "group": ":pleroma", // string
1088 "key": "ModuleName", // string
1089 "type": "group", // string or list with possible values,
1090 "description": "Upload general settings", // string
1093 "key": ":uploader", // string or module name `Pleroma.Upload`
1095 "description": "Module which will be used for uploads",
1096 "suggestions": ["module1", "module2"]
1100 "type": ["list", "module"],
1101 "description": "List of filter modules for uploads",
1103 "module1", "module2", "module3"
1110 ## `GET /api/pleroma/admin/moderation_log`
1112 ### Get moderation log
1115 - *optional* `page`: **integer** page number
1116 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1117 - *optional* `start_date`: **datetime (ISO 8601)** filter logs by creation date, start from `start_date`. Accepts datetime in ISO 8601 format (YYYY-MM-DDThh:mm:ss), e.g. `2005-08-09T18:31:42`
1118 - *optional* `end_date`: **datetime (ISO 8601)** filter logs by creation date, end by from `end_date`. Accepts datetime in ISO 8601 format (YYYY-MM-DDThh:mm:ss), e.g. 2005-08-09T18:31:42
1119 - *optional* `user_id`: **integer** filter logs by actor's id
1120 - *optional* `search`: **string** search logs by the log message
1132 "action": "relay_follow"
1134 "time": 1502812026, // timestamp
1135 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
1140 ## `POST /api/pleroma/admin/reload_emoji`
1142 ### Reload the instance's custom emoji
1144 - Authentication: required
1146 - Response: JSON, "ok" and 200 status
1148 ## `PATCH /api/pleroma/admin/users/confirm_email`
1150 ### Confirm users' emails
1154 - Response: Array of user nicknames
1156 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
1158 ### Resend confirmation email
1162 - Response: Array of user nicknames
1164 ## `GET /api/pleroma/admin/stats`
1169 - *optional* `instance`: **string** instance hostname (without protocol) to get stats for
1170 - Example: `https://mypleroma.org/api/pleroma/admin/stats?instance=lain.com`
1176 "status_visibility": {
1185 ## `GET /api/pleroma/admin/oauth_app`
1191 - *optional* `client_id`
1193 - *optional* `page_size`
1194 - *optional* `trusted`
1204 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1205 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1206 "redirect_uri": "https://example.com/oauth-callback",
1207 "website": "https://example.com",
1217 ## `POST /api/pleroma/admin/oauth_app`
1219 ### Create OAuth App
1225 - *optional* `website`
1226 - *optional* `trusted`
1234 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1235 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1236 "redirect_uri": "https://example.com/oauth-callback",
1237 "website": "https://example.com",
1245 "redirect_uris": "can't be blank",
1246 "name": "can't be blank"
1250 ## `PATCH /api/pleroma/admin/oauth_app/:id`
1252 ### Update OAuth App
1256 - *optional* `redirect_uris`
1257 - *optional* `scopes`
1258 - *optional* `website`
1259 - *optional* `trusted`
1267 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1268 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1269 "redirect_uri": "https://example.com/oauth-callback",
1270 "website": "https://example.com",
1275 ## `DELETE /api/pleroma/admin/oauth_app/:id`
1277 ### Delete OAuth App
1282 - On success: `204`, empty response
1284 - 400 Bad Request `"Invalid parameters"` when `status` is missing
1286 ## `GET /api/pleroma/admin/media_proxy_caches`
1288 ### Get a list of all banned MediaProxy URLs in Cachex
1290 - Authentication: required
1292 - *optional* `page`: **integer** page number
1293 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1294 - *optional* `query`: **string** search term
1300 "page_size": integer,
1303 "http://example.com/media/a688346.jpg",
1304 "http://example.com/media/fb1f4d.jpg"
1310 ## `POST /api/pleroma/admin/media_proxy_caches/delete`
1312 ### Remove a banned MediaProxy URL from Cachex
1314 - Authentication: required
1325 ## `POST /api/pleroma/admin/media_proxy_caches/purge`
1327 ### Purge a MediaProxy URL
1329 - Authentication: required
1341 ## GET /api/pleroma/admin/users/:nickname/chats
1343 ### List a user's chats
1353 "id": "someflakeid",
1354 "username": "somenick",
1358 "id": "someflakeid",
1359 "username": "somenick",
1364 "last_message" : {...}, // The last message in that chat
1365 "updated_at": "2020-04-21T15:11:46.000Z"
1370 ## GET /api/pleroma/admin/chats/:chat_id
1372 ### View a single chat
1381 "id": "someflakeid",
1382 "username": "somenick",
1386 "id": "someflakeid",
1387 "username": "somenick",
1392 "last_message" : {...}, // The last message in that chat
1393 "updated_at": "2020-04-21T15:11:46.000Z"
1397 ## GET /api/pleroma/admin/chats/:chat_id/messages
1399 ### List the messages in a chat
1401 - Params: `max_id`, `min_id`
1408 "account_id": "someflakeid",
1410 "content": "Check this out :firefox:",
1411 "created_at": "2020-04-21T15:11:46.000Z",
1414 "shortcode": "firefox",
1415 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1416 "url": "https://dontbulling.me/emoji/Firefox.gif",
1417 "visible_in_picker": false
1424 "account_id": "someflakeid",
1426 "content": "Whats' up?",
1427 "created_at": "2020-04-21T15:06:45.000Z",
1435 ## DELETE /api/pleroma/admin/chats/:chat_id/messages/:message_id
1437 ### Delete a single message
1445 "account_id": "someflakeid",
1447 "content": "Check this out :firefox:",
1448 "created_at": "2020-04-21T15:11:46.000Z",
1451 "shortcode": "firefox",
1452 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1453 "url": "https://dontbulling.me/emoji/Firefox.gif",
1454 "visible_in_picker": false
1462 ## `GET /api/pleroma/admin/instance_document/:document_name`
1464 ### Get an instance document
1466 - Authentication: required
1470 Returns the content of the document
1473 <h1>Instance panel</h1>
1476 ## `PATCH /api/pleroma/admin/instance_document/:document_name`
1478 - `file` (the file to be uploaded, using multipart form data.)
1480 ### Update an instance document
1482 - Authentication: required
1488 "url": "https://example.com/instance/panel.html"
1492 ## `DELETE /api/pleroma/admin/instance_document/:document_name`
1494 ### Delete an instance document
1500 "url": "https://example.com/instance/panel.html"
1504 ## `GET /api/pleroma/admin/frontends
1506 ### List available frontends
1513 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1514 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1520 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1521 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1529 ## `POST /api/pleroma/admin/frontends/install`
1531 ### Install a frontend
1534 - `name`: frontend name, required
1535 - `ref`: frontend ref
1536 - `file`: path to a frontend zip file
1537 - `build_url`: build URL
1538 - `build_dir`: build directory
1545 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1546 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1552 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1553 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1563 "error": "Could not install frontend"