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, where:
291 - `total`: total count of the statuses for the user
292 - `activities`: list of the statuses for the user
303 ## `GET /api/pleroma/admin/instances/:instance/statuses`
305 ### Retrive instance's latest statuses
308 - `instance`: instance name
309 - *optional* `page_size`: number of statuses to return (default is `20`)
310 - *optional* `godmode`: `true`/`false` – allows to see private statuses
311 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
313 - On failure: `Not found`
314 - On success: JSON array of instance's latest statuses
316 ## `GET /api/pleroma/admin/statuses`
318 ### Retrives all latest statuses
321 - *optional* `page_size`: number of statuses to return (default is `20`)
322 - *optional* `local_only`: excludes remote statuses
323 - *optional* `godmode`: `true`/`false` – allows to see private statuses
324 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
326 - On failure: `Not found`
327 - On success: JSON array of user's latest statuses
329 ## `GET /api/pleroma/admin/relay`
336 * On success: JSON array of relays
340 {"actor": "https://example.com/relay", "followed_back": true},
341 {"actor": "https://example2.com/relay", "followed_back": false}
345 ## `POST /api/pleroma/admin/relay`
355 * On success: relay json object
358 {"actor": "https://example.com/relay", "followed_back": true}
361 ## `DELETE /api/pleroma/admin/relay`
367 - *optional* `force`: forcefully unfollow a relay even when the relay is not available. (default is `false`)
371 * On success: URL of the unfollowed relay
374 {"https://example.com/relay"}
377 ## `POST /api/pleroma/admin/users/invite_token`
379 ### Create an account registration invite token
382 - *optional* `max_use` (integer)
383 - *optional* `expires_at` (date string e.g. "2019-04-07")
394 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
398 ## `GET /api/pleroma/admin/users/invites`
400 ### Get a list of generated invites
416 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
423 ## `POST /api/pleroma/admin/users/revoke_invite`
425 ### Revoke invite by token
439 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
444 ## `POST /api/pleroma/admin/users/email_invite`
446 ### Sends registration invite via email
453 - On success: `204`, empty response
455 - 400 Bad Request, JSON:
460 "error": "Appropriate error message here"
465 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
467 ### Get a password reset token for a given nickname
475 "token": "base64 reset token",
476 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
480 ## `PATCH /api/pleroma/admin/users/force_password_reset`
482 ### Force passord reset for a user with a given nickname
486 - Response: none (code `204`)
488 ## PUT `/api/pleroma/admin/users/disable_mfa`
490 ### Disable mfa for user's account.
494 - Response: User’s nickname
496 ## `GET /api/pleroma/admin/users/:nickname/credentials`
498 ### Get the user's email, password, display and settings-related fields
507 "actor_type": "Person",
508 "allow_following_move": true,
509 "avatar": "https://pleroma.social/media/7e8e7508fd545ef580549b6881d80ec0ff2c81ed9ad37b9bdbbdf0e0d030159d.jpg",
510 "background": "https://pleroma.social/media/4de34c0bd10970d02cbdef8972bef0ebbf55f43cadc449554d4396156162fe9a.jpg",
511 "banner": "https://pleroma.social/media/8d92ba2bd244b613520abf557dd448adcd30f5587022813ee9dd068945986946.jpg",
513 "default_scope": "public",
514 "discoverable": false,
515 "email": "user@example.com",
519 "value": "<a href=\"https://example.com\" rel=\"ugc\">https://example.com</a>"
522 "hide_favorites": false,
523 "hide_followers": false,
524 "hide_followers_count": false,
525 "hide_follows": false,
526 "hide_follows_count": false,
527 "id": "9oouHaEEUR54hls968",
530 "no_rich_text": true,
531 "pleroma_settings_store": {},
536 "value": "https://example.com"
540 "skip_thread_containment": false
544 ## `PATCH /api/pleroma/admin/users/:nickname/credentials`
546 ### Change the user's email, password, display and settings-related fields
560 * `hide_followers_count`
561 * `hide_follows_count`
563 * `allow_following_move`
566 * `skip_thread_containment`
576 {"status": "success"}
583 {"actor_type": "is invalid"},
584 {"email": "has invalid format"},
592 {"error": "Not found"}
595 ## `GET /api/pleroma/admin/reports`
597 ### Get a list of reports
600 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
601 - *optional* `limit`: **integer** the number of records to retrieve
602 - *optional* `page`: **integer** page number
603 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
605 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
606 - On success: JSON, returns a list of reports, where:
607 - `account`: the user who has been reported
608 - `actor`: the user who has sent the report
609 - `statuses`: list of statuses that have been included to the report
618 "avatar": "https://pleroma.example.org/images/avi.png",
619 "avatar_static": "https://pleroma.example.org/images/avi.png",
621 "created_at": "2019-04-23T17:32:04.000Z",
622 "display_name": "User",
625 "followers_count": 1,
626 "following_count": 1,
627 "header": "https://pleroma.example.org/images/banner.png",
628 "header_static": "https://pleroma.example.org/images/banner.png",
629 "id": "9i6dAJqSGSKMzLG2Lo",
633 "confirmation_pending": false,
634 "hide_favorites": true,
635 "hide_followers": false,
636 "hide_follows": false,
638 "is_moderator": false,
647 "tags": ["force_unlisted"],
649 "url": "https://pleroma.example.org/users/user",
654 "avatar": "https://pleroma.example.org/images/avi.png",
655 "avatar_static": "https://pleroma.example.org/images/avi.png",
657 "created_at": "2019-03-28T17:36:03.000Z",
658 "display_name": "Roger Braun",
661 "followers_count": 1,
662 "following_count": 1,
663 "header": "https://pleroma.example.org/images/banner.png",
664 "header_static": "https://pleroma.example.org/images/banner.png",
665 "id": "9hEkA5JsvAdlSrocam",
669 "confirmation_pending": false,
670 "hide_favorites": false,
671 "hide_followers": false,
672 "hide_follows": false,
674 "is_moderator": false,
683 "tags": ["force_unlisted"],
685 "url": "https://pleroma.example.org/users/lain",
688 "content": "Please delete it",
689 "created_at": "2019-04-29T19:48:15.000Z",
690 "id": "9iJGOv1j8hxuw19bcm",
701 "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>",
702 "created_at": "2019-04-23T19:15:47.000Z",
705 "favourites_count": 0,
706 "id": "9i6mQ9uVrrOmOime8m",
707 "in_reply_to_account_id": null,
708 "in_reply_to_id": null,
710 "media_attachments": [],
714 "id": "9hEkA5JsvAdlSrocam",
715 "url": "https://pleroma.example.org/users/lain",
720 "id": "9i6dAJqSGSKMzLG2Lo",
721 "url": "https://pleroma.example.org/users/user",
729 "text/plain": "@lain click on my link https://www.google.com/"
731 "conversation_id": 28,
732 "in_reply_to_account_acct": null,
745 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
746 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
747 "visibility": "direct"
755 ## `GET /api/pleroma/admin/grouped_reports`
757 ### Get a list of reports, grouped by status
760 - On success: JSON, returns a list of reports, where:
761 - `date`: date of the latest report
762 - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
763 - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
764 - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
765 - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
770 "date": "2019-10-07T12:31:39.615149Z",
773 "actors": [{ ... }, { ... }],
779 ## `GET /api/pleroma/admin/reports/:id`
781 ### Get an individual report
787 - 403 Forbidden `{"error": "error_msg"}`
788 - 404 Not Found `"Not found"`
789 - On success: JSON, Report object (see above)
791 ## `PATCH /api/pleroma/admin/reports`
793 ### Change the state of one or multiple reports
800 `id`, // required, report id
801 `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
809 - 400 Bad Request, JSON:
815 `error` // error message
820 - On success: `204`, empty response
822 ## `POST /api/pleroma/admin/reports/:id/notes`
824 ### Create report note
827 - `id`: required, report id
828 - `content`: required, the message
831 - 400 Bad Request `"Invalid parameters"` when `status` is missing
832 - On success: `204`, empty response
834 ## `DELETE /api/pleroma/admin/reports/:report_id/notes/:id`
836 ### Delete report note
839 - `report_id`: required, report id
840 - `id`: required, note id
843 - 400 Bad Request `"Invalid parameters"` when `status` is missing
844 - On success: `204`, empty response
846 ## `GET /api/pleroma/admin/statuses/:id`
848 ### Show status by id
851 - `id`: required, status id
854 - 404 Not Found `"Not Found"`
855 - On success: JSON, Mastodon Status entity
857 ## `PUT /api/pleroma/admin/statuses/:id`
859 ### Change the scope of an individual reported status
863 - `sensitive`: optional, valid values are `true` or `false`
864 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
867 - 400 Bad Request `"Unsupported visibility"`
868 - 403 Forbidden `{"error": "error_msg"}`
869 - 404 Not Found `"Not found"`
870 - On success: JSON, Mastodon Status entity
872 ## `DELETE /api/pleroma/admin/statuses/:id`
874 ### Delete an individual reported status
880 - 403 Forbidden `{"error": "error_msg"}`
881 - 404 Not Found `"Not found"`
882 - On success: 200 OK `{}`
884 ## `GET /api/pleroma/admin/restart`
886 ### Restarts pleroma application
888 **Only works when configuration from database is enabled.**
893 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
899 ## `GET /api/pleroma/admin/need_reboot`
901 ### Returns the flag whether the pleroma should be restarted
905 - `need_reboot` - boolean
912 ## `GET /api/pleroma/admin/config`
914 ### Get list of merged default settings with saved in database.
916 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
918 **Only works when configuration from database is enabled.**
921 - `only_db`: true (*optional*, get only saved in database settings)
924 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
931 "key": "Pleroma.Upload",
939 ## `POST /api/pleroma/admin/config`
941 ### Update config settings
943 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
945 **Only works when configuration from database is enabled.**
947 Some modifications are necessary to save the config settings correctly:
949 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
951 "Pleroma.Upload" -> Pleroma.Upload
954 - strings starting with `:` will be converted to atoms;
956 ":pleroma" -> :pleroma
958 - objects with `tuple` key and array value will be converted to tuples;
960 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
962 - arrays with *tuple objects* will be converted to keywords;
964 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
967 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:
968 - all settings inside these keys:
970 - `:connections_pool`
973 - partially settings inside these keys:
974 - `:seconds_valid` in `Pleroma.Captcha`
975 - `:proxy_remote` in `Pleroma.Upload`
976 - `:upload_limit` in `:instance`
979 - `configs` - array of config objects
980 - config object params:
981 - `group` - string (**required**)
982 - `key` - string (**required**)
983 - `value` - string, [], {} or {"tuple": []} (**required**)
984 - `delete` - true (*optional*, if setting must be deleted)
985 - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
987 *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.*
989 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
990 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
991 [subkey2: val2] \\ value after deletion
994 *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.*
996 Example of setting without keyword in value:
998 config :tesla, :adapter, Tesla.Adapter.Hackney
1001 List of settings which support only full update by key:
1004 {:pleroma, :ecto_repos},
1007 {:cors_plug, [:max_age, :methods, :expose, :headers]},
1008 {:auto_linker, :opts},
1009 {:swarm, :node_blacklist},
1010 {:logger, :backends}
1014 List of settings which support only full update by subkey:
1016 @full_subkey_update [
1017 {:pleroma, :assets, :mascots},
1018 {:pleroma, :emoji, :groups},
1019 {:pleroma, :workers, :retries},
1020 {:pleroma, :mrf_subchain, :match_actor},
1021 {:pleroma, :mrf_keyword, :replace}
1025 *Settings without explicit key must be sended in separate config object params.*
1035 {"group": ":quack", "key": ":level", "value": ":debug"},
1036 {"group": ":quack", "key": ":meta", "value": [":all"]},
1047 "group": ":pleroma",
1048 "key": "Pleroma.Upload",
1050 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
1051 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
1052 {"tuple": [":link_name", true]},
1053 {"tuple": [":proxy_remote", false]},
1054 {"tuple": [":proxy_opts", [
1055 {"tuple": [":redirect_on_failure", false]},
1056 {"tuple": [":max_body_length", 1048576]},
1057 {"tuple": [":http", [
1058 {"tuple": [":follow_redirect", true]},
1059 {"tuple": [":pool", ":upload"]},
1063 {"tuple": [":dispatch", {
1064 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
1074 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
1079 "group": ":pleroma",
1080 "key": "Pleroma.Upload",
1088 ## ` GET /api/pleroma/admin/config/descriptions`
1090 ### Get JSON with config descriptions.
1091 Loads json generated from `config/descriptions.exs`.
1098 "group": ":pleroma", // string
1099 "key": "ModuleName", // string
1100 "type": "group", // string or list with possible values,
1101 "description": "Upload general settings", // string
1104 "key": ":uploader", // string or module name `Pleroma.Upload`
1106 "description": "Module which will be used for uploads",
1107 "suggestions": ["module1", "module2"]
1111 "type": ["list", "module"],
1112 "description": "List of filter modules for uploads",
1114 "module1", "module2", "module3"
1121 ## `GET /api/pleroma/admin/moderation_log`
1123 ### Get moderation log
1126 - *optional* `page`: **integer** page number
1127 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1128 - *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`
1129 - *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
1130 - *optional* `user_id`: **integer** filter logs by actor's id
1131 - *optional* `search`: **string** search logs by the log message
1143 "action": "relay_follow"
1145 "time": 1502812026, // timestamp
1146 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
1151 ## `POST /api/pleroma/admin/reload_emoji`
1153 ### Reload the instance's custom emoji
1155 - Authentication: required
1157 - Response: JSON, "ok" and 200 status
1159 ## `PATCH /api/pleroma/admin/users/confirm_email`
1161 ### Confirm users' emails
1165 - Response: Array of user nicknames
1167 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
1169 ### Resend confirmation email
1173 - Response: Array of user nicknames
1175 ## `GET /api/pleroma/admin/stats`
1180 - *optional* `instance`: **string** instance hostname (without protocol) to get stats for
1181 - Example: `https://mypleroma.org/api/pleroma/admin/stats?instance=lain.com`
1187 "status_visibility": {
1196 ## `GET /api/pleroma/admin/oauth_app`
1202 - *optional* `client_id`
1204 - *optional* `page_size`
1205 - *optional* `trusted`
1215 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1216 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1217 "redirect_uri": "https://example.com/oauth-callback",
1218 "website": "https://example.com",
1228 ## `POST /api/pleroma/admin/oauth_app`
1230 ### Create OAuth App
1236 - *optional* `website`
1237 - *optional* `trusted`
1245 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1246 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1247 "redirect_uri": "https://example.com/oauth-callback",
1248 "website": "https://example.com",
1256 "redirect_uris": "can't be blank",
1257 "name": "can't be blank"
1261 ## `PATCH /api/pleroma/admin/oauth_app/:id`
1263 ### Update OAuth App
1267 - *optional* `redirect_uris`
1268 - *optional* `scopes`
1269 - *optional* `website`
1270 - *optional* `trusted`
1278 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1279 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1280 "redirect_uri": "https://example.com/oauth-callback",
1281 "website": "https://example.com",
1286 ## `DELETE /api/pleroma/admin/oauth_app/:id`
1288 ### Delete OAuth App
1293 - On success: `204`, empty response
1295 - 400 Bad Request `"Invalid parameters"` when `status` is missing
1297 ## `GET /api/pleroma/admin/media_proxy_caches`
1299 ### Get a list of all banned MediaProxy URLs in Cachex
1301 - Authentication: required
1303 - *optional* `page`: **integer** page number
1304 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1305 - *optional* `query`: **string** search term
1311 "page_size": integer,
1314 "http://example.com/media/a688346.jpg",
1315 "http://example.com/media/fb1f4d.jpg"
1321 ## `POST /api/pleroma/admin/media_proxy_caches/delete`
1323 ### Remove a banned MediaProxy URL from Cachex
1325 - Authentication: required
1336 ## `POST /api/pleroma/admin/media_proxy_caches/purge`
1338 ### Purge a MediaProxy URL
1340 - Authentication: required
1352 ## GET /api/pleroma/admin/users/:nickname/chats
1354 ### List a user's chats
1364 "id": "someflakeid",
1365 "username": "somenick",
1369 "id": "someflakeid",
1370 "username": "somenick",
1375 "last_message" : {...}, // The last message in that chat
1376 "updated_at": "2020-04-21T15:11:46.000Z"
1381 ## GET /api/pleroma/admin/chats/:chat_id
1383 ### View a single chat
1392 "id": "someflakeid",
1393 "username": "somenick",
1397 "id": "someflakeid",
1398 "username": "somenick",
1403 "last_message" : {...}, // The last message in that chat
1404 "updated_at": "2020-04-21T15:11:46.000Z"
1408 ## GET /api/pleroma/admin/chats/:chat_id/messages
1410 ### List the messages in a chat
1412 - Params: `max_id`, `min_id`
1419 "account_id": "someflakeid",
1421 "content": "Check this out :firefox:",
1422 "created_at": "2020-04-21T15:11:46.000Z",
1425 "shortcode": "firefox",
1426 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1427 "url": "https://dontbulling.me/emoji/Firefox.gif",
1428 "visible_in_picker": false
1435 "account_id": "someflakeid",
1437 "content": "Whats' up?",
1438 "created_at": "2020-04-21T15:06:45.000Z",
1446 ## DELETE /api/pleroma/admin/chats/:chat_id/messages/:message_id
1448 ### Delete a single message
1456 "account_id": "someflakeid",
1458 "content": "Check this out :firefox:",
1459 "created_at": "2020-04-21T15:11:46.000Z",
1462 "shortcode": "firefox",
1463 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1464 "url": "https://dontbulling.me/emoji/Firefox.gif",
1465 "visible_in_picker": false
1473 ## `GET /api/pleroma/admin/instance_document/:document_name`
1475 ### Get an instance document
1477 - Authentication: required
1481 Returns the content of the document
1484 <h1>Instance panel</h1>
1487 ## `PATCH /api/pleroma/admin/instance_document/:document_name`
1489 - `file` (the file to be uploaded, using multipart form data.)
1491 ### Update an instance document
1493 - Authentication: required
1499 "url": "https://example.com/instance/panel.html"
1503 ## `DELETE /api/pleroma/admin/instance_document/:document_name`
1505 ### Delete an instance document
1511 "url": "https://example.com/instance/panel.html"
1515 ## `GET /api/pleroma/admin/frontends
1517 ### List available frontends
1524 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1525 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1531 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1532 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1540 ## `POST /api/pleroma/admin/frontends/install`
1542 ### Install a frontend
1545 - `name`: frontend name, required
1546 - `ref`: frontend ref
1547 - `file`: path to a frontend zip file
1548 - `build_url`: build URL
1549 - `build_dir`: build directory
1556 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1557 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1563 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1564 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1574 "error": "Could not install frontend"