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 ## `POST /api/pleroma/admin/relay`
288 - On success: URL of the followed relay
290 ## `DELETE /api/pleroma/admin/relay`
297 - On success: URL of the unfollowed relay
299 ## `GET /api/pleroma/admin/relay`
305 - On success: JSON array of relays
307 ## `POST /api/pleroma/admin/users/invite_token`
309 ### Create an account registration invite token
312 - *optional* `max_use` (integer)
313 - *optional* `expires_at` (date string e.g. "2019-04-07")
324 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
328 ## `GET /api/pleroma/admin/users/invites`
330 ### Get a list of generated invites
346 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
353 ## `POST /api/pleroma/admin/users/revoke_invite`
355 ### Revoke invite by token
369 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
374 ## `POST /api/pleroma/admin/users/email_invite`
376 ### Sends registration invite via email
382 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
384 ### Get a password reset token for a given nickname
391 "token": "base64 reset token",
392 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
396 ## `PATCH /api/pleroma/admin/users/force_password_reset`
398 ### Force passord reset for a user with a given nickname
402 - Response: none (code `204`)
404 ## `GET /api/pleroma/admin/reports`
406 ### Get a list of reports
409 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
410 - *optional* `limit`: **integer** the number of records to retrieve
411 - *optional* `page`: **integer** page number
412 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
414 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
415 - On success: JSON, returns a list of reports, where:
416 - `account`: the user who has been reported
417 - `actor`: the user who has sent the report
418 - `statuses`: list of statuses that have been included to the report
427 "avatar": "https://pleroma.example.org/images/avi.png",
428 "avatar_static": "https://pleroma.example.org/images/avi.png",
430 "created_at": "2019-04-23T17:32:04.000Z",
431 "display_name": "User",
434 "followers_count": 1,
435 "following_count": 1,
436 "header": "https://pleroma.example.org/images/banner.png",
437 "header_static": "https://pleroma.example.org/images/banner.png",
438 "id": "9i6dAJqSGSKMzLG2Lo",
442 "confirmation_pending": false,
443 "hide_favorites": true,
444 "hide_followers": false,
445 "hide_follows": false,
447 "is_moderator": false,
456 "tags": ["force_unlisted"],
458 "url": "https://pleroma.example.org/users/user",
463 "avatar": "https://pleroma.example.org/images/avi.png",
464 "avatar_static": "https://pleroma.example.org/images/avi.png",
466 "created_at": "2019-03-28T17:36:03.000Z",
467 "display_name": "Roger Braun",
470 "followers_count": 1,
471 "following_count": 1,
472 "header": "https://pleroma.example.org/images/banner.png",
473 "header_static": "https://pleroma.example.org/images/banner.png",
474 "id": "9hEkA5JsvAdlSrocam",
478 "confirmation_pending": false,
479 "hide_favorites": false,
480 "hide_followers": false,
481 "hide_follows": false,
483 "is_moderator": false,
492 "tags": ["force_unlisted"],
494 "url": "https://pleroma.example.org/users/lain",
497 "content": "Please delete it",
498 "created_at": "2019-04-29T19:48:15.000Z",
499 "id": "9iJGOv1j8hxuw19bcm",
510 "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>",
511 "created_at": "2019-04-23T19:15:47.000Z",
514 "favourites_count": 0,
515 "id": "9i6mQ9uVrrOmOime8m",
516 "in_reply_to_account_id": null,
517 "in_reply_to_id": null,
519 "media_attachments": [],
523 "id": "9hEkA5JsvAdlSrocam",
524 "url": "https://pleroma.example.org/users/lain",
529 "id": "9i6dAJqSGSKMzLG2Lo",
530 "url": "https://pleroma.example.org/users/user",
538 "text/plain": "@lain click on my link https://www.google.com/"
540 "conversation_id": 28,
541 "in_reply_to_account_acct": null,
554 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
555 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
556 "visibility": "direct"
564 ## `GET /api/pleroma/admin/grouped_reports`
566 ### Get a list of reports, grouped by status
569 - On success: JSON, returns a list of reports, where:
570 - `date`: date of the latest report
571 - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
572 - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
573 - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
574 - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
579 "date": "2019-10-07T12:31:39.615149Z",
582 "actors": [{ ... }, { ... }],
588 ## `GET /api/pleroma/admin/reports/:id`
590 ### Get an individual report
596 - 403 Forbidden `{"error": "error_msg"}`
597 - 404 Not Found `"Not found"`
598 - On success: JSON, Report object (see above)
600 ## `PATCH /api/pleroma/admin/reports`
602 ### Change the state of one or multiple reports
609 `id`, // required, report id
610 `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
618 - 400 Bad Request, JSON:
624 `error` // error message
629 - On success: `204`, empty response
631 ## `POST /api/pleroma/admin/reports/:id/notes`
633 ### Create report note
636 - `id`: required, report id
637 - `content`: required, the message
640 - 400 Bad Request `"Invalid parameters"` when `status` is missing
641 - On success: `204`, empty response
643 ## `POST /api/pleroma/admin/reports/:report_id/notes/:id`
645 ### Delete report note
648 - `report_id`: required, report id
649 - `id`: required, note id
652 - 400 Bad Request `"Invalid parameters"` when `status` is missing
653 - On success: `204`, empty response
655 ## `PUT /api/pleroma/admin/statuses/:id`
657 ### Change the scope of an individual reported status
661 - `sensitive`: optional, valid values are `true` or `false`
662 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
665 - 400 Bad Request `"Unsupported visibility"`
666 - 403 Forbidden `{"error": "error_msg"}`
667 - 404 Not Found `"Not found"`
668 - On success: JSON, Mastodon Status entity
670 ## `DELETE /api/pleroma/admin/statuses/:id`
672 ### Delete an individual reported status
678 - 403 Forbidden `{"error": "error_msg"}`
679 - 404 Not Found `"Not found"`
680 - On success: 200 OK `{}`
682 ## `GET /api/pleroma/admin/restart`
684 ### Restarts pleroma application
689 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
695 ## `GET /api/pleroma/admin/config`
697 ### Get list of merged default settings with saved in database.
699 *If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
701 **Only works when configuration from database is enabled.**
704 - `only_db`: true (*optional*, get only saved in database settings)
707 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
714 "key": "Pleroma.Upload",
721 need_reboot - *optional*, if were changed reboot time settings.
723 ## `POST /api/pleroma/admin/config`
725 ### Update config settings
727 *If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
729 **Only works when configuration from database is enabled.**
731 Some modifications are necessary to save the config settings correctly:
733 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
735 "Pleroma.Upload" -> Pleroma.Upload
738 - strings starting with `:` will be converted to atoms;
740 ":pleroma" -> :pleroma
742 - objects with `tuple` key and array value will be converted to tuples;
744 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
746 - arrays with *tuple objects* will be converted to keywords;
748 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
751 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:
752 - all settings inside these keys:
755 - partially settings inside these keys:
756 - `:seconds_valid` in `Pleroma.Captcha`
757 - `:proxy_remote` in `Pleroma.Upload`
758 - `:upload_limit` in `:instance`
761 - `configs` - array of config objects
762 - config object params:
763 - `group` - string (**required**)
764 - `key` - string (**required**)
765 - `value` - string, [], {} or {"tuple": []} (**required**)
766 - `delete` - true (*optional*, if setting must be deleted)
767 - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
769 *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.*
771 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
772 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
773 [subkey2: val2] \\ value after deletion
776 *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.*
778 Example of setting without keyword in value:
780 config :tesla, :adapter, Tesla.Adapter.Hackney
783 List of settings which support only full update by key:
786 {:pleroma, :ecto_repos},
789 {:cors_plug, [:max_age, :methods, :expose, :headers]},
790 {:auto_linker, :opts},
791 {:swarm, :node_blacklist},
796 List of settings which support only full update by subkey:
798 @full_subkey_update [
799 {:pleroma, :assets, :mascots},
800 {:pleroma, :emoji, :groups},
801 {:pleroma, :workers, :retries},
802 {:pleroma, :mrf_subchain, :match_actor},
803 {:pleroma, :mrf_keyword, :replace}
807 *Settings without explicit key must be sended in separate config object params.*
817 {"group": ":quack", "key": ":level", "value": ":debug"},
818 {"group": ":quack", "key": ":meta", "value": [":all"]},
830 "key": "Pleroma.Upload",
832 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
833 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
834 {"tuple": [":link_name", true]},
835 {"tuple": [":proxy_remote", false]},
836 {"tuple": [":proxy_opts", [
837 {"tuple": [":redirect_on_failure", false]},
838 {"tuple": [":max_body_length", 1048576]},
839 {"tuple": [":http", [
840 {"tuple": [":follow_redirect", true]},
841 {"tuple": [":pool", ":upload"]},
845 {"tuple": [":dispatch", {
846 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
856 - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
862 "key": "Pleroma.Upload",
869 need_reboot - *optional*, if were changed reboot time settings.
871 ## ` GET /api/pleroma/admin/config/descriptions`
873 ### Get JSON with config descriptions.
874 Loads json generated from `config/descriptions.exs`.
881 "group": ":pleroma", // string
882 "key": "ModuleName", // string
883 "type": "group", // string or list with possible values,
884 "description": "Upload general settings", // string
887 "key": ":uploader", // string or module name `Pleroma.Upload`
889 "description": "Module which will be used for uploads",
890 "suggestions": ["module1", "module2"]
894 "type": ["list", "module"],
895 "description": "List of filter modules for uploads",
897 "module1", "module2", "module3"
904 ## `GET /api/pleroma/admin/moderation_log`
906 ### Get moderation log
909 - *optional* `page`: **integer** page number
910 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
911 - *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`
912 - *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
913 - *optional* `user_id`: **integer** filter logs by actor's id
914 - *optional* `search`: **string** search logs by the log message
925 "action": "relay_follow"
927 "time": 1502812026, // timestamp
928 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
933 ## `POST /api/pleroma/admin/reload_emoji`
935 ### Reload the instance's custom emoji
937 - Authentication: required
939 - Response: JSON, "ok" and 200 status
941 ## `PATCH /api/pleroma/admin/users/confirm_email`
943 ### Confirm users' emails
947 - Response: Array of user nicknames
949 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
951 ### Resend confirmation email
955 - Response: Array of user nicknames
957 ## `GET /api/pleroma/admin/stats`
965 "status_visibility": {