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 - `deactivated`: only deactivated users
23 - `is_admin`: users with admin role
24 - `is_moderator`: users with moderator role
25 - *optional* `page`: **integer** page number
26 - *optional* `page_size`: **integer** number of users per page (default is `50`)
27 - *optional* `tags`: **[string]** tags list
28 - *optional* `name`: **string** user display name
29 - *optional* `email`: **string** user email
30 - 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`
49 "display_name": string
56 ## DEPRECATED `DELETE /api/pleroma/admin/users`
62 - Response: User’s nickname
64 ## `DELETE /api/pleroma/admin/users`
70 - Response: Array of user nicknames
83 - Response: User’s nickname
85 ## `POST /api/pleroma/admin/users/follow`
87 ### Make a user follow another user
90 - `follower`: The nickname of the follower
91 - `followed`: The nickname of the followed
95 ## `POST /api/pleroma/admin/users/unfollow`
97 ### Make a user unfollow another user
100 - `follower`: The nickname of the follower
101 - `followed`: The nickname of the followed
105 ## `PATCH /api/pleroma/admin/users/:nickname/toggle_activation`
107 ### Toggle user activation
111 - Response: User’s object
121 ## `PUT /api/pleroma/admin/users/tag`
123 ### Tag a list of users
126 - `nicknames` (array)
129 ## `DELETE /api/pleroma/admin/users/tag`
131 ### Untag a list of users
134 - `nicknames` (array)
137 ## `GET /api/pleroma/admin/users/:nickname/permission_group`
139 ### Get user user permission groups membership
146 "is_moderator": bool,
151 ## `GET /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
153 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
155 ### Get user user permission groups membership per permission group
162 "is_moderator": bool,
167 ## DEPRECATED `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
169 ### Add user to permission group
173 - On failure: `{"error": "…"}`
174 - On success: JSON of the user
176 ## `POST /api/pleroma/admin/users/permission_group/:permission_group`
178 ### Add users to permission group
181 - `nicknames`: nicknames array
183 - On failure: `{"error": "…"}`
184 - On success: JSON of the user
186 ## DEPRECATED `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
188 ## `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
190 ### Remove user from permission group
194 - On failure: `{"error": "…"}`
195 - On success: JSON of the user
196 - Note: An admin cannot revoke their own admin status.
198 ## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
200 ### Remove users from permission group
203 - `nicknames`: nicknames array
205 - On failure: `{"error": "…"}`
206 - On success: JSON of the user
207 - Note: An admin cannot revoke their own admin status.
209 ## `PATCH /api/pleroma/admin/users/activate`
214 - `nicknames`: nicknames array
227 ## `PATCH /api/pleroma/admin/users/deactivate`
232 - `nicknames`: nicknames array
245 ## `GET /api/pleroma/admin/users/:nickname_or_id`
247 ### Retrive the details of a user
252 - On failure: `Not found`
253 - On success: JSON of the user
255 ## `GET /api/pleroma/admin/users/:nickname_or_id/statuses`
257 ### Retrive user's latest statuses
261 - *optional* `page_size`: number of statuses to return (default is `20`)
262 - *optional* `godmode`: `true`/`false` – allows to see private statuses
263 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
265 - On failure: `Not found`
266 - On success: JSON array of user's latest statuses
268 ## `GET /api/pleroma/admin/instances/:instance/statuses`
270 ### Retrive instance's latest statuses
273 - `instance`: instance name
274 - *optional* `page_size`: number of statuses to return (default is `20`)
275 - *optional* `godmode`: `true`/`false` – allows to see private statuses
276 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
278 - On failure: `Not found`
279 - On success: JSON array of instance's latest statuses
281 ## `GET /api/pleroma/admin/statuses`
283 ### Retrives all latest statuses
286 - *optional* `page_size`: number of statuses to return (default is `20`)
287 - *optional* `local_only`: excludes remote statuses
288 - *optional* `godmode`: `true`/`false` – allows to see private statuses
289 - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false)
291 - On failure: `Not found`
292 - On success: JSON array of user's latest statuses
294 ## `POST /api/pleroma/admin/relay`
301 - On success: URL of the followed relay
303 ## `DELETE /api/pleroma/admin/relay`
310 - On success: URL of the unfollowed relay
312 ## `GET /api/pleroma/admin/relay`
318 - On success: JSON array of relays
320 ## `POST /api/pleroma/admin/users/invite_token`
322 ### Create an account registration invite token
325 - *optional* `max_use` (integer)
326 - *optional* `expires_at` (date string e.g. "2019-04-07")
337 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
341 ## `GET /api/pleroma/admin/users/invites`
343 ### Get a list of generated invites
359 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
366 ## `POST /api/pleroma/admin/users/revoke_invite`
368 ### Revoke invite by token
382 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
387 ## `POST /api/pleroma/admin/users/email_invite`
389 ### Sends registration invite via email
396 - On success: `204`, empty response
398 - 400 Bad Request, JSON:
403 "error": "Appropriate error message here"
408 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
410 ### Get a password reset token for a given nickname
418 "token": "base64 reset token",
419 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
423 ## `PATCH /api/pleroma/admin/users/force_password_reset`
425 ### Force passord reset for a user with a given nickname
429 - Response: none (code `204`)
431 ## PUT `/api/pleroma/admin/users/disable_mfa`
433 ### Disable mfa for user's account.
437 - Response: User’s nickname
439 ## `GET /api/pleroma/admin/users/:nickname/credentials`
441 ### Get the user's email, password, display and settings-related fields
450 "actor_type": "Person",
451 "allow_following_move": true,
452 "avatar": "https://pleroma.social/media/7e8e7508fd545ef580549b6881d80ec0ff2c81ed9ad37b9bdbbdf0e0d030159d.jpg",
453 "background": "https://pleroma.social/media/4de34c0bd10970d02cbdef8972bef0ebbf55f43cadc449554d4396156162fe9a.jpg",
454 "banner": "https://pleroma.social/media/8d92ba2bd244b613520abf557dd448adcd30f5587022813ee9dd068945986946.jpg",
456 "default_scope": "public",
457 "discoverable": false,
458 "email": "user@example.com",
462 "value": "<a href=\"https://example.com\" rel=\"ugc\">https://example.com</a>"
465 "hide_favorites": false,
466 "hide_followers": false,
467 "hide_followers_count": false,
468 "hide_follows": false,
469 "hide_follows_count": false,
470 "id": "9oouHaEEUR54hls968",
473 "no_rich_text": true,
474 "pleroma_settings_store": {},
479 "value": "https://example.com"
483 "skip_thread_containment": false
487 ## `PATCH /api/pleroma/admin/users/:nickname/credentials`
489 ### Change the user's email, password, display and settings-related fields
503 - `hide_followers_count`
504 - `hide_follows_count`
506 - `allow_following_move`
509 - `skip_thread_containment`
517 {"status": "success"}
522 {"actor_type": "is invalid"},
523 {"email": "has invalid format"},
529 {"error": "Unable to update user."}
532 ## `GET /api/pleroma/admin/reports`
534 ### Get a list of reports
537 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
538 - *optional* `limit`: **integer** the number of records to retrieve
539 - *optional* `page`: **integer** page number
540 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
542 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
543 - On success: JSON, returns a list of reports, where:
544 - `account`: the user who has been reported
545 - `actor`: the user who has sent the report
546 - `statuses`: list of statuses that have been included to the report
555 "avatar": "https://pleroma.example.org/images/avi.png",
556 "avatar_static": "https://pleroma.example.org/images/avi.png",
558 "created_at": "2019-04-23T17:32:04.000Z",
559 "display_name": "User",
562 "followers_count": 1,
563 "following_count": 1,
564 "header": "https://pleroma.example.org/images/banner.png",
565 "header_static": "https://pleroma.example.org/images/banner.png",
566 "id": "9i6dAJqSGSKMzLG2Lo",
570 "confirmation_pending": false,
571 "hide_favorites": true,
572 "hide_followers": false,
573 "hide_follows": false,
575 "is_moderator": false,
584 "tags": ["force_unlisted"],
586 "url": "https://pleroma.example.org/users/user",
591 "avatar": "https://pleroma.example.org/images/avi.png",
592 "avatar_static": "https://pleroma.example.org/images/avi.png",
594 "created_at": "2019-03-28T17:36:03.000Z",
595 "display_name": "Roger Braun",
598 "followers_count": 1,
599 "following_count": 1,
600 "header": "https://pleroma.example.org/images/banner.png",
601 "header_static": "https://pleroma.example.org/images/banner.png",
602 "id": "9hEkA5JsvAdlSrocam",
606 "confirmation_pending": false,
607 "hide_favorites": false,
608 "hide_followers": false,
609 "hide_follows": false,
611 "is_moderator": false,
620 "tags": ["force_unlisted"],
622 "url": "https://pleroma.example.org/users/lain",
625 "content": "Please delete it",
626 "created_at": "2019-04-29T19:48:15.000Z",
627 "id": "9iJGOv1j8hxuw19bcm",
638 "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>",
639 "created_at": "2019-04-23T19:15:47.000Z",
642 "favourites_count": 0,
643 "id": "9i6mQ9uVrrOmOime8m",
644 "in_reply_to_account_id": null,
645 "in_reply_to_id": null,
647 "media_attachments": [],
651 "id": "9hEkA5JsvAdlSrocam",
652 "url": "https://pleroma.example.org/users/lain",
657 "id": "9i6dAJqSGSKMzLG2Lo",
658 "url": "https://pleroma.example.org/users/user",
666 "text/plain": "@lain click on my link https://www.google.com/"
668 "conversation_id": 28,
669 "in_reply_to_account_acct": null,
682 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
683 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
684 "visibility": "direct"
692 ## `GET /api/pleroma/admin/grouped_reports`
694 ### Get a list of reports, grouped by status
697 - On success: JSON, returns a list of reports, where:
698 - `date`: date of the latest report
699 - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
700 - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
701 - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
702 - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
707 "date": "2019-10-07T12:31:39.615149Z",
710 "actors": [{ ... }, { ... }],
716 ## `GET /api/pleroma/admin/reports/:id`
718 ### Get an individual report
724 - 403 Forbidden `{"error": "error_msg"}`
725 - 404 Not Found `"Not found"`
726 - On success: JSON, Report object (see above)
728 ## `PATCH /api/pleroma/admin/reports`
730 ### Change the state of one or multiple reports
737 `id`, // required, report id
738 `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
746 - 400 Bad Request, JSON:
752 `error` // error message
757 - On success: `204`, empty response
759 ## `POST /api/pleroma/admin/reports/:id/notes`
761 ### Create report note
764 - `id`: required, report id
765 - `content`: required, the message
768 - 400 Bad Request `"Invalid parameters"` when `status` is missing
769 - On success: `204`, empty response
771 ## `POST /api/pleroma/admin/reports/:report_id/notes/:id`
773 ### Delete report note
776 - `report_id`: required, report id
777 - `id`: required, note id
780 - 400 Bad Request `"Invalid parameters"` when `status` is missing
781 - On success: `204`, empty response
783 ## `GET /api/pleroma/admin/statuses/:id`
785 ### Show status by id
788 - `id`: required, status id
791 - 404 Not Found `"Not Found"`
792 - On success: JSON, Mastodon Status entity
794 ## `PUT /api/pleroma/admin/statuses/:id`
796 ### Change the scope of an individual reported status
800 - `sensitive`: optional, valid values are `true` or `false`
801 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
804 - 400 Bad Request `"Unsupported visibility"`
805 - 403 Forbidden `{"error": "error_msg"}`
806 - 404 Not Found `"Not found"`
807 - On success: JSON, Mastodon Status entity
809 ## `DELETE /api/pleroma/admin/statuses/:id`
811 ### Delete an individual reported status
817 - 403 Forbidden `{"error": "error_msg"}`
818 - 404 Not Found `"Not found"`
819 - On success: 200 OK `{}`
821 ## `GET /api/pleroma/admin/restart`
823 ### Restarts pleroma application
825 **Only works when configuration from database is enabled.**
830 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
836 ## `GET /api/pleroma/admin/need_reboot`
838 ### Returns the flag whether the pleroma should be restarted
842 - `need_reboot` - boolean
849 ## `GET /api/pleroma/admin/config`
851 ### Get list of merged default settings with saved in database.
853 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
855 **Only works when configuration from database is enabled.**
858 - `only_db`: true (*optional*, get only saved in database settings)
861 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
868 "key": "Pleroma.Upload",
876 ## `POST /api/pleroma/admin/config`
878 ### Update config settings
880 *If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.*
882 **Only works when configuration from database is enabled.**
884 Some modifications are necessary to save the config settings correctly:
886 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
888 "Pleroma.Upload" -> Pleroma.Upload
891 - strings starting with `:` will be converted to atoms;
893 ":pleroma" -> :pleroma
895 - objects with `tuple` key and array value will be converted to tuples;
897 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
899 - arrays with *tuple objects* will be converted to keywords;
901 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
904 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:
905 - all settings inside these keys:
907 - `:connections_pool`
910 - partially settings inside these keys:
911 - `:seconds_valid` in `Pleroma.Captcha`
912 - `:proxy_remote` in `Pleroma.Upload`
913 - `:upload_limit` in `:instance`
916 - `configs` - array of config objects
917 - config object params:
918 - `group` - string (**required**)
919 - `key` - string (**required**)
920 - `value` - string, [], {} or {"tuple": []} (**required**)
921 - `delete` - true (*optional*, if setting must be deleted)
922 - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
924 *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.*
926 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
927 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
928 [subkey2: val2] \\ value after deletion
931 *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.*
933 Example of setting without keyword in value:
935 config :tesla, :adapter, Tesla.Adapter.Hackney
938 List of settings which support only full update by key:
941 {:pleroma, :ecto_repos},
944 {:cors_plug, [:max_age, :methods, :expose, :headers]},
945 {:auto_linker, :opts},
946 {:swarm, :node_blacklist},
951 List of settings which support only full update by subkey:
953 @full_subkey_update [
954 {:pleroma, :assets, :mascots},
955 {:pleroma, :emoji, :groups},
956 {:pleroma, :workers, :retries},
957 {:pleroma, :mrf_subchain, :match_actor},
958 {:pleroma, :mrf_keyword, :replace}
962 *Settings without explicit key must be sended in separate config object params.*
972 {"group": ":quack", "key": ":level", "value": ":debug"},
973 {"group": ":quack", "key": ":meta", "value": [":all"]},
985 "key": "Pleroma.Upload",
987 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
988 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
989 {"tuple": [":link_name", true]},
990 {"tuple": [":proxy_remote", false]},
991 {"tuple": [":proxy_opts", [
992 {"tuple": [":redirect_on_failure", false]},
993 {"tuple": [":max_body_length", 1048576]},
994 {"tuple": [":http", [
995 {"tuple": [":follow_redirect", true]},
996 {"tuple": [":pool", ":upload"]},
1000 {"tuple": [":dispatch", {
1001 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
1011 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
1016 "group": ":pleroma",
1017 "key": "Pleroma.Upload",
1025 ## ` GET /api/pleroma/admin/config/descriptions`
1027 ### Get JSON with config descriptions.
1028 Loads json generated from `config/descriptions.exs`.
1035 "group": ":pleroma", // string
1036 "key": "ModuleName", // string
1037 "type": "group", // string or list with possible values,
1038 "description": "Upload general settings", // string
1041 "key": ":uploader", // string or module name `Pleroma.Upload`
1043 "description": "Module which will be used for uploads",
1044 "suggestions": ["module1", "module2"]
1048 "type": ["list", "module"],
1049 "description": "List of filter modules for uploads",
1051 "module1", "module2", "module3"
1058 ## `GET /api/pleroma/admin/moderation_log`
1060 ### Get moderation log
1063 - *optional* `page`: **integer** page number
1064 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1065 - *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`
1066 - *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
1067 - *optional* `user_id`: **integer** filter logs by actor's id
1068 - *optional* `search`: **string** search logs by the log message
1079 "action": "relay_follow"
1081 "time": 1502812026, // timestamp
1082 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
1087 ## `POST /api/pleroma/admin/reload_emoji`
1089 ### Reload the instance's custom emoji
1091 - Authentication: required
1093 - Response: JSON, "ok" and 200 status
1095 ## `PATCH /api/pleroma/admin/users/confirm_email`
1097 ### Confirm users' emails
1101 - Response: Array of user nicknames
1103 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
1105 ### Resend confirmation email
1109 - Response: Array of user nicknames
1111 ## `GET /api/pleroma/admin/stats`
1119 "status_visibility": {
1128 ## `GET /api/pleroma/admin/oauth_app`
1134 - *optional* `client_id`
1136 - *optional* `page_size`
1137 - *optional* `trusted`
1147 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1148 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1149 "redirect_uri": "https://example.com/oauth-callback",
1150 "website": "https://example.com",
1160 ## `POST /api/pleroma/admin/oauth_app`
1162 ### Create OAuth App
1168 - *optional* `website`
1169 - *optional* `trusted`
1177 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1178 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1179 "redirect_uri": "https://example.com/oauth-callback",
1180 "website": "https://example.com",
1188 "redirect_uris": "can't be blank",
1189 "name": "can't be blank"
1193 ## `PATCH /api/pleroma/admin/oauth_app/:id`
1195 ### Update OAuth App
1199 - *optional* `redirect_uris`
1200 - *optional* `scopes`
1201 - *optional* `website`
1202 - *optional* `trusted`
1210 "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
1211 "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
1212 "redirect_uri": "https://example.com/oauth-callback",
1213 "website": "https://example.com",
1218 ## `DELETE /api/pleroma/admin/oauth_app/:id`
1220 ### Delete OAuth App
1225 - On success: `204`, empty response
1227 - 400 Bad Request `"Invalid parameters"` when `status` is missing