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, where:
315 - `total`: total count of the statuses for the instance
316 - `activities`: list of the statuses for the instance
327 ## `GET /api/pleroma/admin/statuses`
329 ### Retrives all latest statuses
332 - *optional* `page_size`: number of statuses to return (default is `20`)
333 - *optional* `local_only`: excludes remote statuses
334 - *optional* `godmode`: `true`/`false` – allows to see private statuses
335 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
337 - On failure: `Not found`
338 - On success: JSON array of user's latest statuses
340 ## `GET /api/pleroma/admin/relay`
347 * On success: JSON array of relays
351 {"actor": "https://example.com/relay", "followed_back": true},
352 {"actor": "https://example2.com/relay", "followed_back": false}
356 ## `POST /api/pleroma/admin/relay`
366 * On success: relay json object
369 {"actor": "https://example.com/relay", "followed_back": true}
372 ## `DELETE /api/pleroma/admin/relay`
378 - *optional* `force`: forcefully unfollow a relay even when the relay is not available. (default is `false`)
382 * On success: URL of the unfollowed relay
385 {"https://example.com/relay"}
388 ## `POST /api/pleroma/admin/users/invite_token`
390 ### Create an account registration invite token
393 - *optional* `max_use` (integer)
394 - *optional* `expires_at` (date string e.g. "2019-04-07")
405 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
409 ## `GET /api/pleroma/admin/users/invites`
411 ### Get a list of generated invites
427 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
434 ## `POST /api/pleroma/admin/users/revoke_invite`
436 ### Revoke invite by token
450 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
455 ## `POST /api/pleroma/admin/users/email_invite`
457 ### Sends registration invite via email
464 - On success: `204`, empty response
466 - 400 Bad Request, JSON:
471 "error": "Appropriate error message here"
476 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
478 ### Get a password reset token for a given nickname
486 "token": "base64 reset token",
487 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
491 ## `PATCH /api/pleroma/admin/users/force_password_reset`
493 ### Force passord reset for a user with a given nickname
497 - Response: none (code `204`)
499 ## PUT `/api/pleroma/admin/users/disable_mfa`
501 ### Disable mfa for user's account.
505 - Response: User’s nickname
507 ## `GET /api/pleroma/admin/users/:nickname/credentials`
509 ### Get the user's email, password, display and settings-related fields
518 "actor_type": "Person",
519 "allow_following_move": true,
520 "avatar": "https://pleroma.social/media/7e8e7508fd545ef580549b6881d80ec0ff2c81ed9ad37b9bdbbdf0e0d030159d.jpg",
521 "background": "https://pleroma.social/media/4de34c0bd10970d02cbdef8972bef0ebbf55f43cadc449554d4396156162fe9a.jpg",
522 "banner": "https://pleroma.social/media/8d92ba2bd244b613520abf557dd448adcd30f5587022813ee9dd068945986946.jpg",
524 "default_scope": "public",
525 "discoverable": false,
526 "email": "user@example.com",
530 "value": "<a href=\"https://example.com\" rel=\"ugc\">https://example.com</a>"
533 "hide_favorites": false,
534 "hide_followers": false,
535 "hide_followers_count": false,
536 "hide_follows": false,
537 "hide_follows_count": false,
538 "id": "9oouHaEEUR54hls968",
541 "no_rich_text": true,
542 "pleroma_settings_store": {},
547 "value": "https://example.com"
551 "skip_thread_containment": false
555 ## `PATCH /api/pleroma/admin/users/:nickname/credentials`
557 ### Change the user's email, password, display and settings-related fields
571 * `hide_followers_count`
572 * `hide_follows_count`
574 * `allow_following_move`
577 * `skip_thread_containment`
587 {"status": "success"}
594 {"actor_type": "is invalid"},
595 {"email": "has invalid format"},
603 {"error": "Not found"}
606 ## `GET /api/pleroma/admin/reports`
608 ### Get a list of reports
611 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
612 - *optional* `limit`: **integer** the number of records to retrieve
613 - *optional* `page`: **integer** page number
614 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
616 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
617 - On success: JSON, returns a list of reports, where:
618 - `account`: the user who has been reported
619 - `actor`: the user who has sent the report
620 - `statuses`: list of statuses that have been included to the report
629 "avatar": "https://pleroma.example.org/images/avi.png",
630 "avatar_static": "https://pleroma.example.org/images/avi.png",
632 "created_at": "2019-04-23T17:32:04.000Z",
633 "display_name": "User",
636 "followers_count": 1,
637 "following_count": 1,
638 "header": "https://pleroma.example.org/images/banner.png",
639 "header_static": "https://pleroma.example.org/images/banner.png",
640 "id": "9i6dAJqSGSKMzLG2Lo",
644 "confirmation_pending": false,
645 "hide_favorites": true,
646 "hide_followers": false,
647 "hide_follows": false,
649 "is_moderator": false,
658 "tags": ["force_unlisted"],
660 "url": "https://pleroma.example.org/users/user",
665 "avatar": "https://pleroma.example.org/images/avi.png",
666 "avatar_static": "https://pleroma.example.org/images/avi.png",
668 "created_at": "2019-03-28T17:36:03.000Z",
669 "display_name": "Roger Braun",
672 "followers_count": 1,
673 "following_count": 1,
674 "header": "https://pleroma.example.org/images/banner.png",
675 "header_static": "https://pleroma.example.org/images/banner.png",
676 "id": "9hEkA5JsvAdlSrocam",
680 "confirmation_pending": false,
681 "hide_favorites": false,
682 "hide_followers": false,
683 "hide_follows": false,
685 "is_moderator": false,
694 "tags": ["force_unlisted"],
696 "url": "https://pleroma.example.org/users/lain",
699 "content": "Please delete it",
700 "created_at": "2019-04-29T19:48:15.000Z",
701 "id": "9iJGOv1j8hxuw19bcm",
712 "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>",
713 "created_at": "2019-04-23T19:15:47.000Z",
716 "favourites_count": 0,
717 "id": "9i6mQ9uVrrOmOime8m",
718 "in_reply_to_account_id": null,
719 "in_reply_to_id": null,
721 "media_attachments": [],
725 "id": "9hEkA5JsvAdlSrocam",
726 "url": "https://pleroma.example.org/users/lain",
731 "id": "9i6dAJqSGSKMzLG2Lo",
732 "url": "https://pleroma.example.org/users/user",
740 "text/plain": "@lain click on my link https://www.google.com/"
742 "conversation_id": 28,
743 "in_reply_to_account_acct": null,
756 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
757 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
758 "visibility": "direct"
766 ## `GET /api/pleroma/admin/grouped_reports`
768 ### Get a list of reports, grouped by status
771 - On success: JSON, returns a list of reports, where:
772 - `date`: date of the latest report
773 - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
774 - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
775 - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
776 - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
781 "date": "2019-10-07T12:31:39.615149Z",
784 "actors": [{ ... }, { ... }],
790 ## `GET /api/pleroma/admin/reports/:id`
792 ### Get an individual report
798 - 403 Forbidden `{"error": "error_msg"}`
799 - 404 Not Found `"Not found"`
800 - On success: JSON, Report object (see above)
802 ## `PATCH /api/pleroma/admin/reports`
804 ### Change the state of one or multiple reports
811 `id`, // required, report id
812 `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
820 - 400 Bad Request, JSON:
826 `error` // error message
831 - On success: `204`, empty response
833 ## `POST /api/pleroma/admin/reports/:id/notes`
835 ### Create report note
838 - `id`: required, report id
839 - `content`: required, the message
842 - 400 Bad Request `"Invalid parameters"` when `status` is missing
843 - On success: `204`, empty response
845 ## `DELETE /api/pleroma/admin/reports/:report_id/notes/:id`
847 ### Delete report note
850 - `report_id`: required, report id
851 - `id`: required, note id
854 - 400 Bad Request `"Invalid parameters"` when `status` is missing
855 - On success: `204`, empty response
857 ## `GET /api/pleroma/admin/statuses/:id`
859 ### Show status by id
862 - `id`: required, status id
865 - 404 Not Found `"Not Found"`
866 - On success: JSON, Mastodon Status entity
868 ## `PUT /api/pleroma/admin/statuses/:id`
870 ### Change the scope of an individual reported status
874 - `sensitive`: optional, valid values are `true` or `false`
875 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
878 - 400 Bad Request `"Unsupported visibility"`
879 - 403 Forbidden `{"error": "error_msg"}`
880 - 404 Not Found `"Not found"`
881 - On success: JSON, Mastodon Status entity
883 ## `DELETE /api/pleroma/admin/statuses/:id`
885 ### Delete an individual reported status
891 - 403 Forbidden `{"error": "error_msg"}`
892 - 404 Not Found `"Not found"`
893 - On success: 200 OK `{}`
895 ## `GET /api/pleroma/admin/restart`
897 ### Restarts pleroma application
899 **Only works when configuration from database is enabled.**
904 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
910 ## `GET /api/pleroma/admin/need_reboot`
912 ### Returns the flag whether the pleroma should be restarted
916 - `need_reboot` - boolean
923 ## `GET /api/pleroma/admin/config`
925 ### Get list of merged default settings with saved in database.
927 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
929 **Only works when configuration from database is enabled.**
932 - `only_db`: true (*optional*, get only saved in database settings)
935 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
942 "key": "Pleroma.Upload",
950 ## `POST /api/pleroma/admin/config`
952 ### Update config settings
954 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
956 **Only works when configuration from database is enabled.**
958 Some modifications are necessary to save the config settings correctly:
960 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
962 "Pleroma.Upload" -> Pleroma.Upload
965 - strings starting with `:` will be converted to atoms;
967 ":pleroma" -> :pleroma
969 - objects with `tuple` key and array value will be converted to tuples;
971 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
973 - arrays with *tuple objects* will be converted to keywords;
975 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
978 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:
979 - all settings inside these keys:
981 - `:connections_pool`
984 - partially settings inside these keys:
985 - `:seconds_valid` in `Pleroma.Captcha`
986 - `:proxy_remote` in `Pleroma.Upload`
987 - `:upload_limit` in `:instance`
990 - `configs` - array of config objects
991 - config object params:
992 - `group` - string (**required**)
993 - `key` - string (**required**)
994 - `value` - string, [], {} or {"tuple": []} (**required**)
995 - `delete` - true (*optional*, if setting must be deleted)
996 - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
998 *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.*
1000 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
1001 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
1002 [subkey2: val2] \\ value after deletion
1005 *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.*
1007 Example of setting without keyword in value:
1009 config :tesla, :adapter, Tesla.Adapter.Hackney
1012 List of settings which support only full update by key:
1015 {:pleroma, :ecto_repos},
1018 {:cors_plug, [:max_age, :methods, :expose, :headers]},
1019 {:auto_linker, :opts},
1020 {:swarm, :node_blacklist},
1021 {:logger, :backends}
1025 List of settings which support only full update by subkey:
1027 @full_subkey_update [
1028 {:pleroma, :assets, :mascots},
1029 {:pleroma, :emoji, :groups},
1030 {:pleroma, :workers, :retries},
1031 {:pleroma, :mrf_subchain, :match_actor},
1032 {:pleroma, :mrf_keyword, :replace}
1036 *Settings without explicit key must be sended in separate config object params.*
1046 {"group": ":quack", "key": ":level", "value": ":debug"},
1047 {"group": ":quack", "key": ":meta", "value": [":all"]},
1058 "group": ":pleroma",
1059 "key": "Pleroma.Upload",
1061 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
1062 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
1063 {"tuple": [":link_name", true]},
1064 {"tuple": [":proxy_remote", false]},
1065 {"tuple": [":proxy_opts", [
1066 {"tuple": [":redirect_on_failure", false]},
1067 {"tuple": [":max_body_length", 1048576]},
1068 {"tuple": [":http", [
1069 {"tuple": [":follow_redirect", true]},
1070 {"tuple": [":pool", ":upload"]},
1074 {"tuple": [":dispatch", {
1075 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
1085 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
1090 "group": ":pleroma",
1091 "key": "Pleroma.Upload",
1099 ## ` GET /api/pleroma/admin/config/descriptions`
1101 ### Get JSON with config descriptions.
1102 Loads json generated from `config/descriptions.exs`.
1109 "group": ":pleroma", // string
1110 "key": "ModuleName", // string
1111 "type": "group", // string or list with possible values,
1112 "description": "Upload general settings", // string
1115 "key": ":uploader", // string or module name `Pleroma.Upload`
1117 "description": "Module which will be used for uploads",
1118 "suggestions": ["module1", "module2"]
1122 "type": ["list", "module"],
1123 "description": "List of filter modules for uploads",
1125 "module1", "module2", "module3"
1132 ## `GET /api/pleroma/admin/moderation_log`
1134 ### Get moderation log
1137 - *optional* `page`: **integer** page number
1138 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1139 - *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`
1140 - *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
1141 - *optional* `user_id`: **integer** filter logs by actor's id
1142 - *optional* `search`: **string** search logs by the log message
1154 "action": "relay_follow"
1156 "time": 1502812026, // timestamp
1157 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
1162 ## `POST /api/pleroma/admin/reload_emoji`
1164 ### Reload the instance's custom emoji
1166 - Authentication: required
1168 - Response: JSON, "ok" and 200 status
1170 ## `PATCH /api/pleroma/admin/users/confirm_email`
1172 ### Confirm users' emails
1176 - Response: Array of user nicknames
1178 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
1180 ### Resend confirmation email
1184 - Response: Array of user nicknames
1186 ## `GET /api/pleroma/admin/stats`
1191 - *optional* `instance`: **string** instance hostname (without protocol) to get stats for
1192 - Example: `https://mypleroma.org/api/pleroma/admin/stats?instance=lain.com`
1198 "status_visibility": {
1207 ## `GET /api/pleroma/admin/oauth_app`
1213 - *optional* `client_id`
1215 - *optional* `page_size`
1216 - *optional* `trusted`
1226 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1227 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1228 "redirect_uri": "https://example.com/oauth-callback",
1229 "website": "https://example.com",
1239 ## `POST /api/pleroma/admin/oauth_app`
1241 ### Create OAuth App
1247 - *optional* `website`
1248 - *optional* `trusted`
1256 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1257 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1258 "redirect_uri": "https://example.com/oauth-callback",
1259 "website": "https://example.com",
1267 "redirect_uris": "can't be blank",
1268 "name": "can't be blank"
1272 ## `PATCH /api/pleroma/admin/oauth_app/:id`
1274 ### Update OAuth App
1278 - *optional* `redirect_uris`
1279 - *optional* `scopes`
1280 - *optional* `website`
1281 - *optional* `trusted`
1289 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1290 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1291 "redirect_uri": "https://example.com/oauth-callback",
1292 "website": "https://example.com",
1297 ## `DELETE /api/pleroma/admin/oauth_app/:id`
1299 ### Delete OAuth App
1304 - On success: `204`, empty response
1306 - 400 Bad Request `"Invalid parameters"` when `status` is missing
1308 ## `GET /api/pleroma/admin/media_proxy_caches`
1310 ### Get a list of all banned MediaProxy URLs in Cachex
1312 - Authentication: required
1314 - *optional* `page`: **integer** page number
1315 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1316 - *optional* `query`: **string** search term
1322 "page_size": integer,
1325 "http://example.com/media/a688346.jpg",
1326 "http://example.com/media/fb1f4d.jpg"
1332 ## `POST /api/pleroma/admin/media_proxy_caches/delete`
1334 ### Remove a banned MediaProxy URL from Cachex
1336 - Authentication: required
1347 ## `POST /api/pleroma/admin/media_proxy_caches/purge`
1349 ### Purge a MediaProxy URL
1351 - Authentication: required
1363 ## GET /api/pleroma/admin/users/:nickname/chats
1365 ### List a user's chats
1375 "id": "someflakeid",
1376 "username": "somenick",
1380 "id": "someflakeid",
1381 "username": "somenick",
1386 "last_message" : {...}, // The last message in that chat
1387 "updated_at": "2020-04-21T15:11:46.000Z"
1392 ## GET /api/pleroma/admin/chats/:chat_id
1394 ### View a single chat
1403 "id": "someflakeid",
1404 "username": "somenick",
1408 "id": "someflakeid",
1409 "username": "somenick",
1414 "last_message" : {...}, // The last message in that chat
1415 "updated_at": "2020-04-21T15:11:46.000Z"
1419 ## GET /api/pleroma/admin/chats/:chat_id/messages
1421 ### List the messages in a chat
1423 - Params: `max_id`, `min_id`
1430 "account_id": "someflakeid",
1432 "content": "Check this out :firefox:",
1433 "created_at": "2020-04-21T15:11:46.000Z",
1436 "shortcode": "firefox",
1437 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1438 "url": "https://dontbulling.me/emoji/Firefox.gif",
1439 "visible_in_picker": false
1446 "account_id": "someflakeid",
1448 "content": "Whats' up?",
1449 "created_at": "2020-04-21T15:06:45.000Z",
1457 ## DELETE /api/pleroma/admin/chats/:chat_id/messages/:message_id
1459 ### Delete a single message
1467 "account_id": "someflakeid",
1469 "content": "Check this out :firefox:",
1470 "created_at": "2020-04-21T15:11:46.000Z",
1473 "shortcode": "firefox",
1474 "static_url": "https://dontbulling.me/emoji/Firefox.gif",
1475 "url": "https://dontbulling.me/emoji/Firefox.gif",
1476 "visible_in_picker": false
1484 ## `GET /api/pleroma/admin/instance_document/:document_name`
1486 ### Get an instance document
1488 - Authentication: required
1492 Returns the content of the document
1495 <h1>Instance panel</h1>
1498 ## `PATCH /api/pleroma/admin/instance_document/:document_name`
1500 - `file` (the file to be uploaded, using multipart form data.)
1502 ### Update an instance document
1504 - Authentication: required
1510 "url": "https://example.com/instance/panel.html"
1514 ## `DELETE /api/pleroma/admin/instance_document/:document_name`
1516 ### Delete an instance document
1522 "url": "https://example.com/instance/panel.html"
1526 ## `GET /api/pleroma/admin/frontends
1528 ### List available frontends
1535 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1536 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1542 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1543 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1551 ## `POST /api/pleroma/admin/frontends/install`
1553 ### Install a frontend
1556 - `name`: frontend name, required
1557 - `ref`: frontend ref
1558 - `file`: path to a frontend zip file
1559 - `build_url`: build URL
1560 - `build_dir`: build directory
1567 "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build",
1568 "git": "https://git.pleroma.social/pleroma/fedi-fe",
1574 "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build",
1575 "git": "https://git.pleroma.social/lambadalambda/kenoma",
1585 "error": "Could not install frontend"