3 Authentication is required and the user must be an admin.
5 ## `GET /api/pleroma/admin/users`
10 - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)
11 - *optional* `filters`: **string** comma-separated string of filters:
12 - `local`: only local users
13 - `external`: only external users
14 - `active`: only active users
15 - `need_approval`: only unapproved users
16 - `unconfirmed`: only unconfirmed users
17 - `deactivated`: only deactivated users
18 - `is_admin`: users with admin role
19 - `is_moderator`: users with moderator role
20 - *optional* `page`: **integer** page number
21 - *optional* `page_size`: **integer** number of users per page (default is `50`)
22 - *optional* `tags`: **[string]** tags list
23 - *optional* `actor_types`: **[string]** actor type list (`Person`, `Service`, `Application`)
24 - *optional* `name`: **string** user display name
25 - *optional* `email`: **string** user email
26 - 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`
45 "display_name": string,
46 "confirmation_pending": bool,
47 "approval_pending": bool,
48 "registration_reason": string,
55 ## DEPRECATED `DELETE /api/pleroma/admin/users`
61 - Response: User’s nickname
63 ## `DELETE /api/pleroma/admin/users`
69 - Response: Array of user nicknames
82 - Response: User’s nickname
84 ## `POST /api/pleroma/admin/users/follow`
86 ### Make a user follow another user
89 - `follower`: The nickname of the follower
90 - `followed`: The nickname of the followed
94 ## `POST /api/pleroma/admin/users/unfollow`
96 ### Make a user unfollow another user
99 - `follower`: The nickname of the follower
100 - `followed`: The nickname of the followed
104 ## `PATCH /api/pleroma/admin/users/:nickname/toggle_activation`
106 ### Toggle user activation
110 - Response: User’s object
120 ## `PUT /api/pleroma/admin/users/tag`
122 ### Tag a list of users
125 - `nicknames` (array)
128 ## `DELETE /api/pleroma/admin/users/tag`
130 ### Untag a list of users
133 - `nicknames` (array)
136 ## `GET /api/pleroma/admin/users/:nickname/permission_group`
138 ### Get user user permission groups membership
145 "is_moderator": bool,
150 ## `GET /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
152 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
154 ### Get user user permission groups membership per permission group
161 "is_moderator": bool,
166 ## DEPRECATED `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
168 ### Add user to permission group
172 - On failure: `{"error": "…"}`
173 - On success: JSON of the user
175 ## `POST /api/pleroma/admin/users/permission_group/:permission_group`
177 ### Add users to permission group
180 - `nicknames`: nicknames array
182 - On failure: `{"error": "…"}`
183 - On success: JSON of the user
185 ## DEPRECATED `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
187 ## `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
189 ### Remove user from permission group
193 - On failure: `{"error": "…"}`
194 - On success: JSON of the user
195 - Note: An admin cannot revoke their own admin status.
197 ## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
199 ### Remove users from permission group
202 - `nicknames`: nicknames array
204 - On failure: `{"error": "…"}`
205 - On success: JSON of the user
206 - Note: An admin cannot revoke their own admin status.
208 ## `PATCH /api/pleroma/admin/users/activate`
213 - `nicknames`: nicknames array
226 ## `PATCH /api/pleroma/admin/users/deactivate`
231 - `nicknames`: nicknames array
244 ## `PATCH /api/pleroma/admin/users/approve`
249 - `nicknames`: nicknames array
262 ## `GET /api/pleroma/admin/users/:nickname_or_id`
264 ### Retrive the details of a user
269 - On failure: `Not found`
270 - On success: JSON of the user
272 ## `GET /api/pleroma/admin/users/:nickname_or_id/statuses`
274 ### Retrive user's latest statuses
278 - *optional* `page_size`: number of statuses to return (default is `20`)
279 - *optional* `godmode`: `true`/`false` – allows to see private statuses
280 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
282 - On failure: `Not found`
283 - On success: JSON, where:
284 - `total`: total count of the statuses for the user
285 - `activities`: list of the statuses for the user
296 ## `GET /api/pleroma/admin/instances/:instance/statuses`
298 ### Retrive instance's latest statuses
301 - `instance`: instance name
302 - *optional* `page_size`: number of statuses to return (default is `20`)
303 - *optional* `godmode`: `true`/`false` – allows to see private statuses
304 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
306 - On failure: `Not found`
307 - On success: JSON, where:
308 - `total`: total count of the statuses for the instance
309 - `activities`: list of the statuses for the instance
320 ## `GET /api/pleroma/admin/statuses`
322 ### Retrives all latest statuses
325 - *optional* `page_size`: number of statuses to return (default is `20`)
326 - *optional* `local_only`: excludes remote statuses
327 - *optional* `godmode`: `true`/`false` – allows to see private statuses
328 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
330 - On failure: `Not found`
331 - On success: JSON array of user's latest statuses
333 ## `GET /api/pleroma/admin/relay`
340 * On success: JSON array of relays
344 {"actor": "https://example.com/relay", "followed_back": true},
345 {"actor": "https://example2.com/relay", "followed_back": false}
349 ## `POST /api/pleroma/admin/relay`
359 * On success: relay json object
362 {"actor": "https://example.com/relay", "followed_back": true}
365 ## `DELETE /api/pleroma/admin/relay`
371 - *optional* `force`: forcefully unfollow a relay even when the relay is not available. (default is `false`)
375 * On success: URL of the unfollowed relay
378 {"https://example.com/relay"}
381 ## `POST /api/pleroma/admin/users/invite_token`
383 ### Create an account registration invite token
386 - *optional* `max_use` (integer)
387 - *optional* `expires_at` (date string e.g. "2019-04-07")
398 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
402 ## `GET /api/pleroma/admin/users/invites`
404 ### Get a list of generated invites
420 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
427 ## `POST /api/pleroma/admin/users/revoke_invite`
429 ### Revoke invite by token
443 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
448 ## `POST /api/pleroma/admin/users/email_invite`
450 ### Sends registration invite via email
457 - On success: `204`, empty response
459 - 400 Bad Request, JSON:
464 "error": "Appropriate error message here"
469 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
471 ### Get a password reset token for a given nickname
479 "token": "base64 reset token",
480 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
484 ## `PATCH /api/pleroma/admin/users/force_password_reset`
486 ### Force passord reset for a user with a given nickname
490 - Response: none (code `204`)
492 ## PUT `/api/pleroma/admin/users/disable_mfa`
494 ### Disable mfa for user's account.
498 - Response: User’s nickname
500 ## `GET /api/pleroma/admin/users/:nickname/credentials`
502 ### Get the user's email, password, display and settings-related fields
511 "actor_type": "Person",
512 "allow_following_move": true,
513 "avatar": "https://pleroma.social/media/7e8e7508fd545ef580549b6881d80ec0ff2c81ed9ad37b9bdbbdf0e0d030159d.jpg",
514 "background": "https://pleroma.social/media/4de34c0bd10970d02cbdef8972bef0ebbf55f43cadc449554d4396156162fe9a.jpg",
515 "banner": "https://pleroma.social/media/8d92ba2bd244b613520abf557dd448adcd30f5587022813ee9dd068945986946.jpg",
517 "default_scope": "public",
518 "discoverable": false,
519 "email": "user@example.com",
523 "value": "<a href=\"https://example.com\" rel=\"ugc\">https://example.com</a>"
526 "hide_favorites": false,
527 "hide_followers": false,
528 "hide_followers_count": false,
529 "hide_follows": false,
530 "hide_follows_count": false,
531 "id": "9oouHaEEUR54hls968",
534 "no_rich_text": true,
535 "pleroma_settings_store": {},
540 "value": "https://example.com"
544 "skip_thread_containment": false
548 ## `PATCH /api/pleroma/admin/users/:nickname/credentials`
550 ### Change the user's email, password, display and settings-related fields
564 * `hide_followers_count`
565 * `hide_follows_count`
567 * `allow_following_move`
570 * `skip_thread_containment`
580 {"status": "success"}
587 {"actor_type": "is invalid"},
588 {"email": "has invalid format"},
596 {"error": "Not found"}
599 ## `GET /api/pleroma/admin/reports`
601 ### Get a list of reports
604 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
605 - *optional* `limit`: **integer** the number of records to retrieve
606 - *optional* `page`: **integer** page number
607 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
609 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
610 - On success: JSON, returns a list of reports, where:
611 - `account`: the user who has been reported
612 - `actor`: the user who has sent the report
613 - `statuses`: list of statuses that have been included to the report
622 "avatar": "https://pleroma.example.org/images/avi.png",
623 "avatar_static": "https://pleroma.example.org/images/avi.png",
625 "created_at": "2019-04-23T17:32:04.000Z",
626 "display_name": "User",
629 "followers_count": 1,
630 "following_count": 1,
631 "header": "https://pleroma.example.org/images/banner.png",
632 "header_static": "https://pleroma.example.org/images/banner.png",
633 "id": "9i6dAJqSGSKMzLG2Lo",
637 "confirmation_pending": false,
638 "hide_favorites": true,
639 "hide_followers": false,
640 "hide_follows": false,
642 "is_moderator": false,
651 "tags": ["force_unlisted"],
653 "url": "https://pleroma.example.org/users/user",
658 "avatar": "https://pleroma.example.org/images/avi.png",
659 "avatar_static": "https://pleroma.example.org/images/avi.png",
661 "created_at": "2019-03-28T17:36:03.000Z",
662 "display_name": "Roger Braun",
665 "followers_count": 1,
666 "following_count": 1,
667 "header": "https://pleroma.example.org/images/banner.png",
668 "header_static": "https://pleroma.example.org/images/banner.png",
669 "id": "9hEkA5JsvAdlSrocam",
673 "confirmation_pending": false,
674 "hide_favorites": false,
675 "hide_followers": false,
676 "hide_follows": false,
678 "is_moderator": false,
687 "tags": ["force_unlisted"],
689 "url": "https://pleroma.example.org/users/lain",
692 "content": "Please delete it",
693 "created_at": "2019-04-29T19:48:15.000Z",
694 "id": "9iJGOv1j8hxuw19bcm",
705 "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>",
706 "created_at": "2019-04-23T19:15:47.000Z",
709 "favourites_count": 0,
710 "id": "9i6mQ9uVrrOmOime8m",
711 "in_reply_to_account_id": null,
712 "in_reply_to_id": null,
714 "media_attachments": [],
718 "id": "9hEkA5JsvAdlSrocam",
719 "url": "https://pleroma.example.org/users/lain",
724 "id": "9i6dAJqSGSKMzLG2Lo",
725 "url": "https://pleroma.example.org/users/user",
733 "text/plain": "@lain click on my link https://www.google.com/"
735 "conversation_id": 28,
736 "in_reply_to_account_acct": null,
749 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
750 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
751 "visibility": "direct"
759 ## `GET /api/pleroma/admin/grouped_reports`
761 ### Get a list of reports, grouped by status
764 - On success: JSON, returns a list of reports, where:
765 - `date`: date of the latest report
766 - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
767 - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
768 - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
769 - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
774 "date": "2019-10-07T12:31:39.615149Z",
777 "actors": [{ ... }, { ... }],
783 ## `GET /api/pleroma/admin/reports/:id`
785 ### Get an individual report
791 - 403 Forbidden `{"error": "error_msg"}`
792 - 404 Not Found `"Not found"`
793 - On success: JSON, Report object (see above)
795 ## `PATCH /api/pleroma/admin/reports`
797 ### Change the state of one or multiple reports
804 `id`, // required, report id
805 `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
813 - 400 Bad Request, JSON:
819 `error` // error message
824 - On success: `204`, empty response
826 ## `POST /api/pleroma/admin/reports/:id/notes`
828 ### Create report note
831 - `id`: required, report id
832 - `content`: required, the message
835 - 400 Bad Request `"Invalid parameters"` when `status` is missing
836 - On success: `204`, empty response
838 ## `DELETE /api/pleroma/admin/reports/:report_id/notes/:id`
840 ### Delete report note
843 - `report_id`: required, report id
844 - `id`: required, note id
847 - 400 Bad Request `"Invalid parameters"` when `status` is missing
848 - On success: `204`, empty response
850 ## `GET /api/pleroma/admin/statuses/:id`
852 ### Show status by id
855 - `id`: required, status id
858 - 404 Not Found `"Not Found"`
859 - On success: JSON, Mastodon Status entity
861 ## `PUT /api/pleroma/admin/statuses/:id`
863 ### Change the scope of an individual reported status
867 - `sensitive`: optional, valid values are `true` or `false`
868 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
871 - 400 Bad Request `"Unsupported visibility"`
872 - 403 Forbidden `{"error": "error_msg"}`
873 - 404 Not Found `"Not found"`
874 - On success: JSON, Mastodon Status entity
876 ## `DELETE /api/pleroma/admin/statuses/:id`
878 ### Delete an individual reported status
884 - 403 Forbidden `{"error": "error_msg"}`
885 - 404 Not Found `"Not found"`
886 - On success: 200 OK `{}`
888 ## `GET /api/pleroma/admin/restart`
890 ### Restarts pleroma application
892 **Only works when configuration from database is enabled.**
897 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
903 ## `GET /api/pleroma/admin/need_reboot`
905 ### Returns the flag whether the pleroma should be restarted
909 - `need_reboot` - boolean
916 ## `GET /api/pleroma/admin/config`
918 ### Get list of merged default settings with saved in database.
920 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
922 **Only works when configuration from database is enabled.**
925 - `only_db`: true (*optional*, get only saved in database settings)
928 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
935 "key": "Pleroma.Upload",
943 ## `POST /api/pleroma/admin/config`
945 ### Update config settings
947 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
949 **Only works when configuration from database is enabled.**
951 Some modifications are necessary to save the config settings correctly:
953 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
955 "Pleroma.Upload" -> Pleroma.Upload
958 - strings starting with `:` will be converted to atoms;
960 ":pleroma" -> :pleroma
962 - objects with `tuple` key and array value will be converted to tuples;
964 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
966 - arrays with *tuple objects* will be converted to keywords;
968 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
971 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:
972 - all settings inside these keys:
974 - `:connections_pool`
977 - partially settings inside these keys:
978 - `:seconds_valid` in `Pleroma.Captcha`
979 - `:proxy_remote` in `Pleroma.Upload`
980 - `:upload_limit` in `:instance`
983 - `configs` - array of config objects
984 - config object params:
985 - `group` - string (**required**)
986 - `key` - string (**required**)
987 - `value` - string, [], {} or {"tuple": []} (**required**)
988 - `delete` - true (*optional*, if setting must be deleted)
989 - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
991 *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.*
993 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
994 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
995 [subkey2: val2] \\ value after deletion
998 *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.*
1000 Example of setting without keyword in value:
1002 config :tesla, :adapter, Tesla.Adapter.Hackney
1005 List of settings which support only full update by key:
1008 {:pleroma, :ecto_repos},
1011 {:cors_plug, [:max_age, :methods, :expose, :headers]},
1012 {:auto_linker, :opts},
1013 {:swarm, :node_blacklist},
1014 {:logger, :backends}
1018 List of settings which support only full update by subkey:
1020 @full_subkey_update [
1021 {:pleroma, :assets, :mascots},
1022 {:pleroma, :emoji, :groups},
1023 {:pleroma, :workers, :retries},
1024 {:pleroma, :mrf_subchain, :match_actor},
1025 {:pleroma, :mrf_keyword, :replace}
1029 *Settings without explicit key must be sended in separate config object params.*
1039 {"group": ":quack", "key": ":level", "value": ":debug"},
1040 {"group": ":quack", "key": ":meta", "value": [":all"]},
1051 "group": ":pleroma",
1052 "key": "Pleroma.Upload",
1054 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
1055 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
1056 {"tuple": [":link_name", true]},
1057 {"tuple": [":proxy_remote", false]},
1058 {"tuple": [":proxy_opts", [
1059 {"tuple": [":redirect_on_failure", false]},
1060 {"tuple": [":max_body_length", 1048576]},
1061 {"tuple": [":http", [
1062 {"tuple": [":follow_redirect", true]},
1063 {"tuple": [":pool", ":upload"]},
1067 {"tuple": [":dispatch", {
1068 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
1078 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
1083 "group": ":pleroma",
1084 "key": "Pleroma.Upload",
1092 ## ` GET /api/pleroma/admin/config/descriptions`
1094 ### Get JSON with config descriptions.
1095 Loads json generated from `config/descriptions.exs`.
1102 "group": ":pleroma", // string
1103 "key": "ModuleName", // string
1104 "type": "group", // string or list with possible values,
1105 "description": "Upload general settings", // string
1108 "key": ":uploader", // string or module name `Pleroma.Upload`
1110 "description": "Module which will be used for uploads",
1111 "suggestions": ["module1", "module2"]
1115 "type": ["list", "module"],
1116 "description": "List of filter modules for uploads",
1118 "module1", "module2", "module3"
1125 ## `GET /api/pleroma/admin/moderation_log`
1127 ### Get moderation log
1130 - *optional* `page`: **integer** page number
1131 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1132 - *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`
1133 - *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
1134 - *optional* `user_id`: **integer** filter logs by actor's id
1135 - *optional* `search`: **string** search logs by the log message
1147 "action": "relay_follow"
1149 "time": 1502812026, // timestamp
1150 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
1155 ## `POST /api/pleroma/admin/reload_emoji`
1157 ### Reload the instance's custom emoji
1159 - Authentication: required
1161 - Response: JSON, "ok" and 200 status
1163 ## `PATCH /api/pleroma/admin/users/confirm_email`
1165 ### Confirm users' emails
1169 - Response: Array of user nicknames
1171 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
1173 ### Resend confirmation email
1177 - Response: Array of user nicknames
1179 ## `GET /api/pleroma/admin/stats`
1184 - *optional* `instance`: **string** instance hostname (without protocol) to get stats for
1185 - Example: `https://mypleroma.org/api/pleroma/admin/stats?instance=lain.com`
1191 "status_visibility": {
1200 ## `GET /api/pleroma/admin/oauth_app`
1206 - *optional* `client_id`
1208 - *optional* `page_size`
1209 - *optional* `trusted`
1219 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1220 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1221 "redirect_uri": "https://example.com/oauth-callback",
1222 "website": "https://example.com",
1232 ## `POST /api/pleroma/admin/oauth_app`
1234 ### Create OAuth App
1240 - *optional* `website`
1241 - *optional* `trusted`
1249 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1250 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1251 "redirect_uri": "https://example.com/oauth-callback",
1252 "website": "https://example.com",
1260 "redirect_uris": "can't be blank",
1261 "name": "can't be blank"
1265 ## `PATCH /api/pleroma/admin/oauth_app/:id`
1267 ### Update OAuth App
1271 - *optional* `redirect_uris`
1272 - *optional* `scopes`
1273 - *optional* `website`
1274 - *optional* `trusted`
1282 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1283 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1284 "redirect_uri": "https://example.com/oauth-callback",
1285 "website": "https://example.com",
1290 ## `DELETE /api/pleroma/admin/oauth_app/:id`
1292 ### Delete OAuth App
1297 - On success: `204`, empty response
1299 - 400 Bad Request `"Invalid parameters"` when `status` is missing
1301 ## `GET /api/pleroma/admin/media_proxy_caches`
1303 ### Get a list of all banned MediaProxy URLs in Cachex
1305 - Authentication: required
1307 - *optional* `page`: **integer** page number
1308 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1309 - *optional* `query`: **string** search term
1315 "page_size": integer,
1318 "http://example.com/media/a688346.jpg",
1319 "http://example.com/media/fb1f4d.jpg"
1325 ## `POST /api/pleroma/admin/media_proxy_caches/delete`
1327 ### Remove a banned MediaProxy URL from Cachex
1329 - Authentication: required
1340 ## `POST /api/pleroma/admin/media_proxy_caches/purge`
1342 ### Purge a MediaProxy URL
1344 - Authentication: required
1356 ## GET /api/pleroma/admin/users/:nickname/chats
1358 ### List a user's chats
1368 "id": "someflakeid",
1369 "username": "somenick",
1373 "id": "someflakeid",
1374 "username": "somenick",
1379 "last_message" : {...}, // The last message in that chat
1380 "updated_at": "2020-04-21T15:11:46.000Z"
1385 ## GET /api/pleroma/admin/chats/:chat_id
1387 ### View a single chat
1396 "id": "someflakeid",
1397 "username": "somenick",
1401 "id": "someflakeid",
1402 "username": "somenick",
1407 "last_message" : {...}, // The last message in that chat
1408 "updated_at": "2020-04-21T15:11:46.000Z"
1412 ## GET /api/pleroma/admin/chats/:chat_id/messages
1414 ### List the messages in a chat
1416 - Params: `max_id`, `min_id`
1423 "account_id": "someflakeid",
1425 "content": "Check this out :firefox:",
1426 "created_at": "2020-04-21T15:11:46.000Z",
1429 "shortcode": "firefox",
1430 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1431 "url": "https://dontbulling.me/emoji/Firefox.gif",
1432 "visible_in_picker": false
1439 "account_id": "someflakeid",
1441 "content": "Whats' up?",
1442 "created_at": "2020-04-21T15:06:45.000Z",
1450 ## DELETE /api/pleroma/admin/chats/:chat_id/messages/:message_id
1452 ### Delete a single message
1460 "account_id": "someflakeid",
1462 "content": "Check this out :firefox:",
1463 "created_at": "2020-04-21T15:11:46.000Z",
1466 "shortcode": "firefox",
1467 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1468 "url": "https://dontbulling.me/emoji/Firefox.gif",
1469 "visible_in_picker": false
1477 ## `GET /api/pleroma/admin/instance_document/:document_name`
1479 ### Get an instance document
1481 - Authentication: required
1485 Returns the content of the document
1488 <h1>Instance panel</h1>
1491 ## `PATCH /api/pleroma/admin/instance_document/:document_name`
1493 - `file` (the file to be uploaded, using multipart form data.)
1495 ### Update an instance document
1497 - Authentication: required
1503 "url": "https://example.com/instance/panel.html"
1507 ## `DELETE /api/pleroma/admin/instance_document/:document_name`
1509 ### Delete an instance document
1515 "url": "https://example.com/instance/panel.html"
1519 ## `GET /api/pleroma/admin/frontends
1521 ### List available frontends
1528 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1529 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1535 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1536 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1544 ## `POST /api/pleroma/admin/frontends/install`
1546 ### Install a frontend
1549 - `name`: frontend name, required
1550 - `ref`: frontend ref
1551 - `file`: path to a frontend zip file
1552 - `build_url`: build URL
1553 - `build_dir`: build directory
1560 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1561 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1567 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1568 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1578 "error": "Could not install frontend"