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 ### Add user in permission group
162 - On failure: `{"error": "…"}`
163 - On success: JSON of the `user.info`
165 ### Remove user from permission group
170 - On failure: `{"error": "…"}`
171 - On success: JSON of the `user.info`
172 - Note: An admin cannot revoke their own admin status.
174 ## `/api/pleroma/admin/users/:nickname/activation_status`
176 ### Active or deactivate a user
181 - `status` BOOLEAN field, false value means deactivation.
183 ## `/api/pleroma/admin/users/:nickname_or_id`
185 ### Retrive the details of a user
191 - On failure: `Not found`
192 - On success: JSON of the user
194 ## `/api/pleroma/admin/users/:nickname_or_id/statuses`
196 ### Retrive user's latest statuses
201 - *optional* `page_size`: number of statuses to return (default is `20`)
202 - *optional* `godmode`: `true`/`false` – allows to see private statuses
204 - On failure: `Not found`
205 - On success: JSON array of user's latest statuses
207 ## `/api/pleroma/admin/relay`
215 - On success: URL of the followed relay
223 - On success: URL of the unfollowed relay
225 ## `/api/pleroma/admin/users/invite_token`
227 ### Get an account registration invite token
231 - *optional* `invite` => [
232 - *optional* `max_use` (integer)
233 - *optional* `expires_at` (date string e.g. "2019-04-07")
235 - Response: invite token (base64 string)
237 ## `/api/pleroma/admin/users/invites`
239 ### Get a list of generated invites
256 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
263 ## `/api/pleroma/admin/users/revoke_invite`
265 ### Revoke invite by token
280 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
286 ## `/api/pleroma/admin/users/email_invite`
288 ### Sends registration invite via email
295 ## `/api/pleroma/admin/users/:nickname/password_reset`
297 ### Get a password reset token for a given nickname
301 - Response: password reset token (base64 string)
303 ## `/api/pleroma/admin/reports`
304 ### Get a list of reports
307 - `state`: optional, the state of reports. Valid values are `open`, `closed` and `resolved`
308 - `limit`: optional, the number of records to retrieve
309 - `since_id`: optional, returns results that are more recent than the specified id
310 - `max_id`: optional, returns results that are older than the specified id
312 - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
313 - On success: JSON, returns a list of reports, where:
314 - `account`: the user who has been reported
315 - `actor`: the user who has sent the report
316 - `statuses`: list of statuses that have been included to the report
325 "avatar": "https://pleroma.example.org/images/avi.png",
326 "avatar_static": "https://pleroma.example.org/images/avi.png",
328 "created_at": "2019-04-23T17:32:04.000Z",
329 "display_name": "User",
332 "followers_count": 1,
333 "following_count": 1,
334 "header": "https://pleroma.example.org/images/banner.png",
335 "header_static": "https://pleroma.example.org/images/banner.png",
336 "id": "9i6dAJqSGSKMzLG2Lo",
340 "confirmation_pending": false,
341 "hide_favorites": true,
342 "hide_followers": false,
343 "hide_follows": false,
345 "is_moderator": false,
354 "tags": ["force_unlisted"],
356 "url": "https://pleroma.example.org/users/user",
361 "avatar": "https://pleroma.example.org/images/avi.png",
362 "avatar_static": "https://pleroma.example.org/images/avi.png",
364 "created_at": "2019-03-28T17:36:03.000Z",
365 "display_name": "Roger Braun",
368 "followers_count": 1,
369 "following_count": 1,
370 "header": "https://pleroma.example.org/images/banner.png",
371 "header_static": "https://pleroma.example.org/images/banner.png",
372 "id": "9hEkA5JsvAdlSrocam",
376 "confirmation_pending": false,
377 "hide_favorites": false,
378 "hide_followers": false,
379 "hide_follows": false,
381 "is_moderator": false,
390 "tags": ["force_unlisted"],
392 "url": "https://pleroma.example.org/users/lain",
395 "content": "Please delete it",
396 "created_at": "2019-04-29T19:48:15.000Z",
397 "id": "9iJGOv1j8hxuw19bcm",
408 "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>",
409 "created_at": "2019-04-23T19:15:47.000Z",
412 "favourites_count": 0,
413 "id": "9i6mQ9uVrrOmOime8m",
414 "in_reply_to_account_id": null,
415 "in_reply_to_id": null,
417 "media_attachments": [],
421 "id": "9hEkA5JsvAdlSrocam",
422 "url": "https://pleroma.example.org/users/lain",
427 "id": "9i6dAJqSGSKMzLG2Lo",
428 "url": "https://pleroma.example.org/users/user",
436 "text/plain": "@lain click on my link https://www.google.com/"
438 "conversation_id": 28,
439 "in_reply_to_account_acct": null,
452 "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
453 "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
454 "visibility": "direct"
462 ## `/api/pleroma/admin/reports/:id`
463 ### Get an individual report
469 - 403 Forbidden `{"error": "error_msg"}`
470 - 404 Not Found `"Not found"`
471 - On success: JSON, Report object (see above)
473 ## `/api/pleroma/admin/reports/:id`
474 ### Change the state of the report
478 - `state`: required, the new state. Valid values are `open`, `closed` and `resolved`
481 - 400 Bad Request `"Unsupported state"`
482 - 403 Forbidden `{"error": "error_msg"}`
483 - 404 Not Found `"Not found"`
484 - On success: JSON, Report object (see above)
486 ## `/api/pleroma/admin/reports/:id/respond`
487 ### Respond to a report
491 - `status`: required, the message
494 - 400 Bad Request `"Invalid parameters"` when `status` is missing
495 - 403 Forbidden `{"error": "error_msg"}`
496 - 404 Not Found `"Not found"`
497 - On success: JSON, created Mastodon Status entity
508 "content": "Your claim is going to be closed",
509 "created_at": "2019-05-11T17:13:03.000Z",
512 "favourites_count": 0,
513 "id": "9ihuiSL1405I65TmEq",
514 "in_reply_to_account_id": null,
515 "in_reply_to_id": null,
517 "media_attachments": [],
521 "id": "9i6dAJqSGSKMzLG2Lo",
522 "url": "https://pleroma.example.org/users/user",
527 "id": "9hEkA5JsvAdlSrocam",
528 "url": "https://pleroma.example.org/users/admin",
536 "text/plain": "Your claim is going to be closed"
538 "conversation_id": 35,
539 "in_reply_to_account_acct": null,
552 "uri": "https://pleroma.example.org/objects/cab0836d-9814-46cd-a0ea-529da9db5fcb",
553 "url": "https://pleroma.example.org/notice/9ihuiSL1405I65TmEq",
554 "visibility": "direct"
558 ## `/api/pleroma/admin/statuses/:id`
559 ### Change the scope of an individual reported status
563 - `sensitive`: optional, valid values are `true` or `false`
564 - `visibility`: optional, valid values are `public`, `private` and `unlisted`
567 - 400 Bad Request `"Unsupported visibility"`
568 - 403 Forbidden `{"error": "error_msg"}`
569 - 404 Not Found `"Not found"`
570 - On success: JSON, Mastodon Status entity
572 ## `/api/pleroma/admin/statuses/:id`
573 ### Delete an individual reported status
579 - 403 Forbidden `{"error": "error_msg"}`
580 - 404 Not Found `"Not found"`
581 - On success: 200 OK `{}`
584 ## `/api/pleroma/admin/config/migrate_to_db`
585 ### Run mix task pleroma.config migrate_to_db
586 Copy settings on key `:pleroma` to DB.
595 ## `/api/pleroma/admin/config/migrate_from_db`
596 ### Run mix task pleroma.config migrate_from_db
597 Copy all settings from DB to `config/prod.exported_from_db.secret.exs` with deletion from DB.
606 ## `/api/pleroma/admin/config`
607 ### List config settings
608 List config settings only works with `:pleroma => :instance => :dynamic_configuration` setting to `true`.
618 "key": string or string with leading `:` for atoms,
619 "value": string or {} or [] or {"tuple": []}
625 ## `/api/pleroma/admin/config`
626 ### Update config settings
627 Updating config settings only works with `:pleroma => :instance => :dynamic_configuration` setting to `true`.
628 Module name can be passed as string, which starts with `Pleroma`, e.g. `"Pleroma.Upload"`.
629 Atom keys and values can be passed with `:` in the beginning, e.g. `":upload"`.
630 Tuples can be passed as `{"tuple": ["first_val", Pleroma.Module, []]}`.
631 `{"tuple": ["some_string", "Pleroma.Some.Module", []]}` will be converted to `{"some_string", Pleroma.Some.Module, []}`.
632 Keywords can be passed as lists with 2 child tuples, e.g.
633 `[{"tuple": ["first_val", Pleroma.Module]}, {"tuple": ["second_val", true]}]`.
635 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.:
636 {"group": "pleroma", "key": "some_key", "delete": "true", "subkeys": [":subkey", ":subkey3"]}.
638 Compile time settings (need instance reboot):
639 - all settings by this keys:
642 - `Pleroma.Web.Endpoint`
645 - `Pleroma.Captcha` -> `:seconds_valid`
646 - `Pleroma.Upload` -> `:proxy_remote`
647 - `:instance` -> `:upload_limit`
653 - `key` (string or string with leading `:` for atoms)
654 - `value` (string, [], {} or {"tuple": []})
655 - `delete` = true (optional, if parameter must be deleted)
656 - `subkeys` [(string with leading `:` for atoms)] (optional, works only if `delete=true` parameter is passed, otherwise will be ignored)
666 "key": "Pleroma.Upload",
668 {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
669 {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
670 {"tuple": [":link_name", true]},
671 {"tuple": [":proxy_remote", false]},
672 {"tuple": [":proxy_opts", [
673 {"tuple": [":redirect_on_failure", false]},
674 {"tuple": [":max_body_length", 1048576]},
675 {"tuple": [":http": [
676 {"tuple": [":follow_redirect", true]},
677 {"tuple": [":pool", ":upload"]},
681 {"tuple": [":dispatch", {
682 "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
696 "key": string or string with leading `:` for atoms,
697 "value": string or {} or [] or {"tuple": []}
703 ## `/api/pleroma/admin/moderation_log`
704 ### Get moderation log
707 - *optional* `page`: **integer** page number
708 - *optional* `page_size`: **integer** number of users per page (default is `50`)
719 "action": "relay_follow"
721 "time": 1502812026, // timestamp
722 "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message