3 Authentication is required and the user must be an admin.
5 ## `/api/pleroma/admin/users`
11 - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)
12 - *optional* `filters`: **string** comma-separated string of filters:
13 - `local`: only local users
14 - `external`: only external users
15 - `active`: only active users
16 - `deactivated`: only deactivated users
17 - `is_admin`: users with admin role
18 - `is_moderator`: users with moderator role
19 - *optional* `page`: **integer** page number
20 - *optional* `page_size`: **integer** number of users per page (default is `50`)
21 - *optional* `tags`: **[string]** tags list
22 - *optional* `name`: **string** user display name
23 - *optional* `email`: **string** user email
24 - 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`
43 "display_name": string
50 ## `/api/pleroma/admin/users`
57 - Response: User’s nickname
70 - Response: User’s nickname
72 ## `/api/pleroma/admin/users/follow`
73 ### Make a user follow another user
77 - `follower`: The nickname of the follower
78 - `followed`: The nickname of the followed
82 ## `/api/pleroma/admin/users/unfollow`
83 ### Make a user unfollow another user
87 - `follower`: The nickname of the follower
88 - `followed`: The nickname of the followed
92 ## `/api/pleroma/admin/users/:nickname/toggle_activation`
94 ### Toggle user activation
99 - Response: User’s object
109 ## `/api/pleroma/admin/users/tag`
111 ### Tag a list of users
115 - `nicknames` (array)
118 ### Untag a list of users
122 - `nicknames` (array)
125 ## `/api/pleroma/admin/users/:nickname/permission_group`
127 ### Get user user permission groups membership
135 "is_moderator": bool,
140 ## `/api/pleroma/admin/users/:nickname/permission_group/:permission_group`
142 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
144 ### Get user user permission groups membership per permission group
152 "is_moderator": bool,
157 ## `POST /api/pleroma/admin/users/permission_group/:permission_group`
159 ### Add user in permission group
162 - `nicknames`: nicknames array
164 - On failure: `{"error": "…"}`
165 - On success: JSON of the `user.info`
167 ## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
169 ### Remove user from permission group
172 - `nicknames`: nicknames array
174 - On failure: `{"error": "…"}`
175 - On success: JSON of the `user.info`
176 - Note: An admin cannot revoke their own admin status.
178 ## `PATCH /api/pleroma/admin/users/activate`
183 - `nicknames`: nicknames array
196 ## `PATCH /api/pleroma/admin/users/deactivate`
201 - `nicknames`: nicknames array
214 ## `/api/pleroma/admin/users/:nickname_or_id`
216 ### Retrive the details of a user
222 - On failure: `Not found`
223 - On success: JSON of the user
225 ## `/api/pleroma/admin/users/:nickname_or_id/statuses`
227 ### Retrive user's latest statuses
232 - *optional* `page_size`: number of statuses to return (default is `20`)
233 - *optional* `godmode`: `true`/`false` – allows to see private statuses
235 - On failure: `Not found`
236 - On success: JSON array of user's latest statuses
238 ## `/api/pleroma/admin/relay`
246 - On success: URL of the followed relay
254 - On success: URL of the unfollowed relay
256 ## `/api/pleroma/admin/users/invite_token`
258 ### Create an account registration invite token
262 - *optional* `max_use` (integer)
263 - *optional* `expires_at` (date string e.g. "2019-04-07")
274 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
278 ## `/api/pleroma/admin/users/invites`
280 ### Get a list of generated invites
297 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
304 ## `/api/pleroma/admin/users/revoke_invite`
306 ### Revoke invite by token
321 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
327 ## `/api/pleroma/admin/users/email_invite`
329 ### Sends registration invite via email
336 ## `/api/pleroma/admin/users/:nickname/password_reset`
338 ### Get a password reset token for a given nickname
346 "token": "base64 reset token",
347 "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
352 ## `/api/pleroma/admin/users/:nickname/force_password_reset`
354 ### Force passord reset for a user with a given nickname
358 - Response: none (code `204`)
360 ## `/api/pleroma/admin/reports`
361 ### Get a list of reports
364 - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
365 - *optional* `limit`: **integer** the number of records to retrieve
366 - *optional* `page`: **integer** page number
367 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
369 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
370 - On success: JSON, returns a list of reports, where:
371 - `account`: the user who has been reported
372 - `actor`: the user who has sent the report
373 - `statuses`: list of statuses that have been included to the report
382 "avatar": "https://pleroma.example.org/images/avi.png",
383 "avatar_static": "https://pleroma.example.org/images/avi.png",
385 "created_at": "2019-04-23T17:32:04.000Z",
386 "display_name": "User",
389 "followers_count": 1,
390 "following_count": 1,
391 "header": "https://pleroma.example.org/images/banner.png",
392 "header_static": "https://pleroma.example.org/images/banner.png",
393 "id": "9i6dAJqSGSKMzLG2Lo",
397 "confirmation_pending": false,
398 "hide_favorites": true,
399 "hide_followers": false,
400 "hide_follows": false,
402 "is_moderator": false,
411 "tags": ["force_unlisted"],
413 "url": "https://pleroma.example.org/users/user",
418 "avatar": "https://pleroma.example.org/images/avi.png",
419 "avatar_static": "https://pleroma.example.org/images/avi.png",
421 "created_at": "2019-03-28T17:36:03.000Z",
422 "display_name": "Roger Braun",
425 "followers_count": 1,
426 "following_count": 1,
427 "header": "https://pleroma.example.org/images/banner.png",
428 "header_static": "https://pleroma.example.org/images/banner.png",
429 "id": "9hEkA5JsvAdlSrocam",
433 "confirmation_pending": false,
434 "hide_favorites": false,
435 "hide_followers": false,
436 "hide_follows": false,
438 "is_moderator": false,
447 "tags": ["force_unlisted"],
449 "url": "https://pleroma.example.org/users/lain",
452 "content": "Please delete it",
453 "created_at": "2019-04-29T19:48:15.000Z",
454 "id": "9iJGOv1j8hxuw19bcm",
465 "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>",
466 "created_at": "2019-04-23T19:15:47.000Z",
469 "favourites_count": 0,
470 "id": "9i6mQ9uVrrOmOime8m",
471 "in_reply_to_account_id": null,
472 "in_reply_to_id": null,
474 "media_attachments": [],
478 "id": "9hEkA5JsvAdlSrocam",
479 "url": "https://pleroma.example.org/users/lain",
484 "id": "9i6dAJqSGSKMzLG2Lo",
485 "url": "https://pleroma.example.org/users/user",
493 "text/plain": "@lain click on my link https://www.google.com/"
495 "conversation_id": 28,
496 "in_reply_to_account_acct": null,
509 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
510 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
511 "visibility": "direct"
519 ## `/api/pleroma/admin/reports/:id`
520 ### Get an individual report
526 - 403 Forbidden `{"error": "error_msg"}`
527 - 404 Not Found `"Not found"`
528 - On success: JSON, Report object (see above)
530 ## `/api/pleroma/admin/reports/:id`
531 ### Change the state of the report
535 - `state`: required, the new state. Valid values are `open`, `closed` and `resolved`
538 - 400 Bad Request `"Unsupported state"`
539 - 403 Forbidden `{"error": "error_msg"}`
540 - 404 Not Found `"Not found"`
541 - On success: JSON, Report object (see above)
543 ## `/api/pleroma/admin/reports/:id/respond`
544 ### Respond to a report
548 - `status`: required, the message
551 - 400 Bad Request `"Invalid parameters"` when `status` is missing
552 - 403 Forbidden `{"error": "error_msg"}`
553 - 404 Not Found `"Not found"`
554 - On success: JSON, created Mastodon Status entity
565 "content": "Your claim is going to be closed",
566 "created_at": "2019-05-11T17:13:03.000Z",
569 "favourites_count": 0,
570 "id": "9ihuiSL1405I65TmEq",
571 "in_reply_to_account_id": null,
572 "in_reply_to_id": null,
574 "media_attachments": [],
578 "id": "9i6dAJqSGSKMzLG2Lo",
579 "url": "https://pleroma.example.org/users/user",
584 "id": "9hEkA5JsvAdlSrocam",
585 "url": "https://pleroma.example.org/users/admin",
593 "text/plain": "Your claim is going to be closed"
595 "conversation_id": 35,
596 "in_reply_to_account_acct": null,
609 "uri": "https://pleroma.example.org/objects/cab0836d-9814-46cd-a0ea-529da9db5fcb",
610 "url": "https://pleroma.example.org/notice/9ihuiSL1405I65TmEq",
611 "visibility": "direct"
615 ## `/api/pleroma/admin/statuses/:id`
616 ### Change the scope of an individual reported status
620 - `sensitive`: optional, valid values are `true` or `false`
621 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
624 - 400 Bad Request `"Unsupported visibility"`
625 - 403 Forbidden `{"error": "error_msg"}`
626 - 404 Not Found `"Not found"`
627 - On success: JSON, Mastodon Status entity
629 ## `/api/pleroma/admin/statuses/:id`
630 ### Delete an individual reported status
636 - 403 Forbidden `{"error": "error_msg"}`
637 - 404 Not Found `"Not found"`
638 - On success: 200 OK `{}`
641 ## `/api/pleroma/admin/config/migrate_to_db`
642 ### Run mix task pleroma.config migrate_to_db
643 Copy settings on key `:pleroma` to DB.
652 ## `/api/pleroma/admin/config/migrate_from_db`
653 ### Run mix task pleroma.config migrate_from_db
654 Copy all settings from DB to `config/prod.exported_from_db.secret.exs` with deletion from DB.
663 ## `/api/pleroma/admin/config`
664 ### List config settings
665 List config settings only works with `:pleroma => :instance => :dynamic_configuration` setting to `true`.
675 "key": string or string with leading `:` for atoms,
676 "value": string or {} or [] or {"tuple": []}
682 ## `/api/pleroma/admin/config`
683 ### Update config settings
684 Updating config settings only works with `:pleroma => :instance => :dynamic_configuration` setting to `true`.
685 Module name can be passed as string, which starts with `Pleroma`, e.g. `"Pleroma.Upload"`.
686 Atom keys and values can be passed with `:` in the beginning, e.g. `":upload"`.
687 Tuples can be passed as `{"tuple": ["first_val", Pleroma.Module, []]}`.
688 `{"tuple": ["some_string", "Pleroma.Some.Module", []]}` will be converted to `{"some_string", Pleroma.Some.Module, []}`.
689 Keywords can be passed as lists with 2 child tuples, e.g.
690 `[{"tuple": ["first_val", Pleroma.Module]}, {"tuple": ["second_val", true]}]`.
692 If value contains list of settings `[subkey: val1, subkey2: val2, subkey3: val3]`, it's possible to remove only subkeys instead of all settings passing `subkeys` parameter. E.g.:
693 {"group": "pleroma", "key": "some_key", "delete": "true", "subkeys": [":subkey", ":subkey3"]}.
695 Compile time settings (need instance reboot):
696 - all settings by this keys:
699 - `Pleroma.Web.Endpoint`
702 - `Pleroma.Captcha` -> `:seconds_valid`
703 - `Pleroma.Upload` -> `:proxy_remote`
704 - `:instance` -> `:upload_limit`
710 - `key` (string or string with leading `:` for atoms)
711 - `value` (string, [], {} or {"tuple": []})
712 - `delete` = true (optional, if parameter must be deleted)
713 - `subkeys` [(string with leading `:` for atoms)] (optional, works only if `delete=true` parameter is passed, otherwise will be ignored)
723 "key": "Pleroma.Upload",
725 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
726 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
727 {"tuple": [":link_name", true]},
728 {"tuple": [":proxy_remote", false]},
729 {"tuple": [":proxy_opts", [
730 {"tuple": [":redirect_on_failure", false]},
731 {"tuple": [":max_body_length", 1048576]},
732 {"tuple": [":http": [
733 {"tuple": [":follow_redirect", true]},
734 {"tuple": [":pool", ":upload"]},
738 {"tuple": [":dispatch", {
739 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
754 "key": string or string with leading `:` for atoms,
755 "value": string or {} or [] or {"tuple": []}
761 ## `/api/pleroma/admin/moderation_log`
762 ### Get moderation log
765 - *optional* `page`: **integer** page number
766 - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
767 - *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`
768 - *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
769 - *optional* `user_id`: **integer** filter logs by actor's id
770 - *optional* `search`: **string** search logs by the log message
781 "action": "relay_follow"
783 "time": 1502812026, // timestamp
784 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
789 ## `POST /api/pleroma/admin/reload_emoji`
790 ### Reload the instance's custom emoji
792 * Authentication: required
794 * Response: JSON, "ok" and 200 status