git.squeep.com Git - akkoma/blob - docs/API/admin_api.md

   1 # Admin API
   2
   3 Authentication is required and the user must be an admin.
   4
   5 Configuration options:
   6
   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.
  11
  12 ## `GET /api/pleroma/admin/users`
  13
  14 ### List users
  15
  16 - Query Params:
  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`
  31 - Response:
  32
  33 ```json
  34 {
  35   "page_size": integer,
  36   "count": integer,
  37   "users": [
  38     {
  39       "deactivated": bool,
  40       "id": integer,
  41       "nickname": string,
  42       "roles": {
  43         "admin": bool,
  44         "moderator": bool
  45       },
  46       "local": bool,
  47       "tags": array,
  48       "avatar": string,
  49       "display_name": string
  50     },
  51     ...
  52   ]
  53 }
  54 ```
  55
  56 ## DEPRECATED `DELETE /api/pleroma/admin/users`
  57
  58 ### Remove a user
  59
  60 - Params:
  61   - `nickname`
  62 - Response: User’s nickname
  63
  64 ## `DELETE /api/pleroma/admin/users`
  65
  66 ### Remove a user
  67
  68 - Params:
  69   - `nicknames`
  70 - Response: Array of user nicknames
  71
  72 ### Create a user
  73
  74 - Method: `POST`
  75 - Params:
  76   `users`: [
  77     {
  78       `nickname`,
  79       `email`,
  80       `password`
  81     }
  82   ]
  83 - Response: User’s nickname
  84
  85 ## `POST /api/pleroma/admin/users/follow`
  86
  87 ### Make a user follow another user
  88
  89 - Params:
  90   - `follower`: The nickname of the follower
  91   - `followed`: The nickname of the followed
  92 - Response:
  93   - "ok"
  94
  95 ## `POST /api/pleroma/admin/users/unfollow`
  96
  97 ### Make a user unfollow another user
  98
  99 - Params:
 100   - `follower`: The nickname of the follower
 101   - `followed`: The nickname of the followed
 102 - Response:
 103   - "ok"
 104
 105 ## `PATCH /api/pleroma/admin/users/:nickname/toggle_activation`
 106
 107 ### Toggle user activation
 108
 109 - Params:
 110   - `nickname`
 111 - Response: User’s object
 112
 113 ```json
 114 {
 115   "deactivated": bool,
 116   "id": integer,
 117   "nickname": string
 118 }
 119 ```
 120
 121 ## `PUT /api/pleroma/admin/users/tag`
 122
 123 ### Tag a list of users
 124
 125 - Params:
 126   - `nicknames` (array)
 127   - `tags` (array)
 128
 129 ## `DELETE /api/pleroma/admin/users/tag`
 130
 131 ### Untag a list of users
 132
 133 - Params:
 134   - `nicknames` (array)
 135   - `tags` (array)
 136
 137 ## `GET /api/pleroma/admin/users/:nickname/permission_group`
 138
 139 ### Get user user permission groups membership
 140
 141 - Params: none
 142 - Response:
 143
 144 ```json
 145 {
 146   "is_moderator": bool,
 147   "is_admin": bool
 148 }
 149 ```
 150
 151 ## `GET /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
 152
 153 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
 154
 155 ### Get user user permission groups membership per permission group
 156
 157 - Params: none
 158 - Response:
 159
 160 ```json
 161 {
 162   "is_moderator": bool,
 163   "is_admin": bool
 164 }
 165 ```
 166
 167 ## DEPRECATED `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
 168
 169 ### Add user to permission group
 170
 171 - Params: none
 172 - Response:
 173   - On failure: `{"error": "…"}`
 174   - On success: JSON of the user
 175
 176 ## `POST /api/pleroma/admin/users/permission_group/:permission_group`
 177
 178 ### Add users to permission group
 179
 180 - Params:
 181   - `nicknames`: nicknames array
 182 - Response:
 183   - On failure: `{"error": "…"}`
 184   - On success: JSON of the user
 185
 186 ## DEPRECATED `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
 187
 188 ## `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
 189
 190 ### Remove user from permission group
 191
 192 - Params: none
 193 - Response:
 194   - On failure: `{"error": "…"}`
 195   - On success: JSON of the user
 196 - Note: An admin cannot revoke their own admin status.
 197
 198 ## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
 199
 200 ### Remove users from permission group
 201
 202 - Params:
 203   - `nicknames`: nicknames array
 204 - Response:
 205   - On failure: `{"error": "…"}`
 206   - On success: JSON of the user
 207 - Note: An admin cannot revoke their own admin status.
 208
 209 ## `PATCH /api/pleroma/admin/users/activate`
 210
 211 ### Activate user
 212
 213 - Params:
 214   - `nicknames`: nicknames array
 215 - Response:
 216
 217 ```json
 218 {
 219   users: [
 220     {
 221       // user object
 222     }
 223   ]
 224 }
 225 ```
 226
 227 ## `PATCH /api/pleroma/admin/users/deactivate`
 228
 229 ### Deactivate user
 230
 231 - Params:
 232   - `nicknames`: nicknames array
 233 - Response:
 234
 235 ```json
 236 {
 237   users: [
 238     {
 239       // user object
 240     }
 241   ]
 242 }
 243 ```
 244
 245 ## `GET /api/pleroma/admin/users/:nickname_or_id`
 246
 247 ### Retrive the details of a user
 248
 249 - Params:
 250   - `nickname` or `id`
 251 - Response:
 252   - On failure: `Not found`
 253   - On success: JSON of the user
 254
 255 ## `GET /api/pleroma/admin/users/:nickname_or_id/statuses`
 256
 257 ### Retrive user's latest statuses
 258
 259 - Params:
 260   - `nickname` or `id`
 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)
 264 - Response:
 265   - On failure: `Not found`
 266   - On success: JSON array of user's latest statuses
 267
 268 ## `GET /api/pleroma/admin/instances/:instance/statuses`
 269
 270 ### Retrive instance's latest statuses
 271
 272 - Params:
 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)
 277 - Response:
 278   - On failure: `Not found`
 279   - On success: JSON array of instance's latest statuses
 280
 281 ## `GET /api/pleroma/admin/statuses`
 282
 283 ### Retrives all latest statuses
 284
 285 - Params:
 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)
 290 - Response:
 291   - On failure: `Not found`
 292   - On success: JSON array of user's latest statuses
 293
 294 ## `POST /api/pleroma/admin/relay`
 295
 296 ### Follow a Relay
 297
 298 - Params:
 299   - `relay_url`
 300 - Response:
 301   - On success: URL of the followed relay
 302
 303 ## `DELETE /api/pleroma/admin/relay`
 304
 305 ### Unfollow a Relay
 306
 307 - Params:
 308   - `relay_url`
 309 - Response:
 310   - On success: URL of the unfollowed relay
 311
 312 ## `GET /api/pleroma/admin/relay`
 313
 314 ### List Relays
 315
 316 - Params: none
 317 - Response:
 318   - On success: JSON array of relays
 319
 320 ## `POST /api/pleroma/admin/users/invite_token`
 321
 322 ### Create an account registration invite token
 323
 324 - Params:
 325   - *optional* `max_use` (integer)
 326   - *optional* `expires_at` (date string e.g. "2019-04-07")
 327 - Response:
 328
 329 ```json
 330 {
 331   "id": integer,
 332   "token": string,
 333   "used": boolean,
 334   "expires_at": date,
 335   "uses": integer,
 336   "max_use": integer,
 337   "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
 338 }
 339 ```
 340
 341 ## `GET /api/pleroma/admin/users/invites`
 342
 343 ### Get a list of generated invites
 344
 345 - Params: none
 346 - Response:
 347
 348 ```json
 349 {
 350
 351   "invites": [
 352     {
 353       "id": integer,
 354       "token": string,
 355       "used": boolean,
 356       "expires_at": date,
 357       "uses": integer,
 358       "max_use": integer,
 359       "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
 360     },
 361     ...
 362   ]
 363 }
 364 ```
 365
 366 ## `POST /api/pleroma/admin/users/revoke_invite`
 367
 368 ### Revoke invite by token
 369
 370 - Params:
 371   - `token`
 372 - Response:
 373
 374 ```json
 375 {
 376   "id": integer,
 377   "token": string,
 378   "used": boolean,
 379   "expires_at": date,
 380   "uses": integer,
 381   "max_use": integer,
 382   "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
 383
 384 }
 385 ```
 386
 387 ## `POST /api/pleroma/admin/users/email_invite`
 388
 389 ### Sends registration invite via email
 390
 391 - Params:
 392   - `email`
 393   - `name`, optional
 394
 395 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
 396
 397 ### Get a password reset token for a given nickname
 398
 399 - Params: none
 400 - Response:
 401
 402 ```json
 403 {
 404   "token": "base64 reset token",
 405   "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
 406 }
 407 ```
 408
 409 ## `PATCH /api/pleroma/admin/users/force_password_reset`
 410
 411 ### Force passord reset for a user with a given nickname
 412
 413 - Params:
 414   - `nicknames`
 415 - Response: none (code `204`)
 416
 417 ## `PATCH /api/pleroma/admin/users/:nickname/change_password`
 418
 419 ### Change the user password
 420
 421 - Params:
 422   - `new_password`
 423 - Response: none (code `200`)
 424
 425 ## `GET /api/pleroma/admin/reports`
 426
 427 ### Get a list of reports
 428
 429 - Params:
 430   - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
 431   - *optional* `limit`: **integer** the number of records to retrieve
 432   - *optional* `page`: **integer** page number
 433   - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
 434 - Response:
 435   - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
 436   - On success: JSON, returns a list of reports, where:
 437     - `account`: the user who has been reported
 438     - `actor`: the user who has sent the report
 439     - `statuses`: list of statuses that have been included to the report
 440
 441 ```json
 442 {
 443   "totalReports" : 1,
 444   "reports": [
 445     {
 446       "account": {
 447         "acct": "user",
 448         "avatar": "https://pleroma.example.org/images/avi.png",
 449         "avatar_static": "https://pleroma.example.org/images/avi.png",
 450         "bot": false,
 451         "created_at": "2019-04-23T17:32:04.000Z",
 452         "display_name": "User",
 453         "emojis": [],
 454         "fields": [],
 455         "followers_count": 1,
 456         "following_count": 1,
 457         "header": "https://pleroma.example.org/images/banner.png",
 458         "header_static": "https://pleroma.example.org/images/banner.png",
 459         "id": "9i6dAJqSGSKMzLG2Lo",
 460         "locked": false,
 461         "note": "",
 462         "pleroma": {
 463           "confirmation_pending": false,
 464           "hide_favorites": true,
 465           "hide_followers": false,
 466           "hide_follows": false,
 467           "is_admin": false,
 468           "is_moderator": false,
 469           "relationship": {},
 470           "tags": []
 471         },
 472         "source": {
 473           "note": "",
 474           "pleroma": {},
 475           "sensitive": false
 476         },
 477         "tags": ["force_unlisted"],
 478         "statuses_count": 3,
 479         "url": "https://pleroma.example.org/users/user",
 480         "username": "user"
 481       },
 482       "actor": {
 483         "acct": "lain",
 484         "avatar": "https://pleroma.example.org/images/avi.png",
 485         "avatar_static": "https://pleroma.example.org/images/avi.png",
 486         "bot": false,
 487         "created_at": "2019-03-28T17:36:03.000Z",
 488         "display_name": "Roger Braun",
 489         "emojis": [],
 490         "fields": [],
 491         "followers_count": 1,
 492         "following_count": 1,
 493         "header": "https://pleroma.example.org/images/banner.png",
 494         "header_static": "https://pleroma.example.org/images/banner.png",
 495         "id": "9hEkA5JsvAdlSrocam",
 496         "locked": false,
 497         "note": "",
 498         "pleroma": {
 499           "confirmation_pending": false,
 500           "hide_favorites": false,
 501           "hide_followers": false,
 502           "hide_follows": false,
 503           "is_admin": false,
 504           "is_moderator": false,
 505           "relationship": {},
 506           "tags": []
 507         },
 508         "source": {
 509           "note": "",
 510           "pleroma": {},
 511           "sensitive": false
 512         },
 513         "tags": ["force_unlisted"],
 514         "statuses_count": 1,
 515         "url": "https://pleroma.example.org/users/lain",
 516         "username": "lain"
 517       },
 518       "content": "Please delete it",
 519       "created_at": "2019-04-29T19:48:15.000Z",
 520       "id": "9iJGOv1j8hxuw19bcm",
 521       "state": "open",
 522       "statuses": [
 523         {
 524           "account": { ... },
 525           "application": {
 526             "name": "Web",
 527             "website": null
 528           },
 529           "bookmarked": false,
 530           "card": null,
 531           "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>",
 532           "created_at": "2019-04-23T19:15:47.000Z",
 533           "emojis": [],
 534           "favourited": false,
 535           "favourites_count": 0,
 536           "id": "9i6mQ9uVrrOmOime8m",
 537           "in_reply_to_account_id": null,
 538           "in_reply_to_id": null,
 539           "language": null,
 540           "media_attachments": [],
 541           "mentions": [
 542             {
 543               "acct": "lain",
 544               "id": "9hEkA5JsvAdlSrocam",
 545               "url": "https://pleroma.example.org/users/lain",
 546               "username": "lain"
 547             },
 548             {
 549               "acct": "user",
 550               "id": "9i6dAJqSGSKMzLG2Lo",
 551               "url": "https://pleroma.example.org/users/user",
 552               "username": "user"
 553             }
 554           ],
 555           "muted": false,
 556           "pinned": false,
 557           "pleroma": {
 558             "content": {
 559               "text/plain": "@lain click on my link https://www.google.com/"
 560             },
 561             "conversation_id": 28,
 562             "in_reply_to_account_acct": null,
 563             "local": true,
 564             "spoiler_text": {
 565               "text/plain": ""
 566             }
 567           },
 568           "reblog": null,
 569           "reblogged": false,
 570           "reblogs_count": 0,
 571           "replies_count": 0,
 572           "sensitive": false,
 573           "spoiler_text": "",
 574           "tags": [],
 575           "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
 576           "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
 577           "visibility": "direct"
 578         }
 579       ]
 580     }
 581   ]
 582 }
 583 ```
 584
 585 ## `GET /api/pleroma/admin/grouped_reports`
 586
 587 ### Get a list of reports, grouped by status
 588
 589 - Params: none
 590 - On success: JSON, returns a list of reports, where:
 591   - `date`: date of the latest report
 592   - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
 593   - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
 594   - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
 595   - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
 596
 597 ```json
 598   "reports": [
 599     {
 600       "date": "2019-10-07T12:31:39.615149Z",
 601       "account": { ... },
 602       "status": { ... },
 603       "actors": [{ ... }, { ... }],
 604       "reports": [{ ... }]
 605     }
 606   ]
 607 ```
 608
 609 ## `GET /api/pleroma/admin/reports/:id`
 610
 611 ### Get an individual report
 612
 613 - Params:
 614   - `id`
 615 - Response:
 616   - On failure:
 617     - 403 Forbidden `{"error": "error_msg"}`
 618     - 404 Not Found `"Not found"`
 619   - On success: JSON, Report object (see above)
 620
 621 ## `PATCH /api/pleroma/admin/reports`
 622
 623 ### Change the state of one or multiple reports
 624
 625 - Params:
 626
 627 ```json
 628   `reports`: [
 629     {
 630       `id`, // required, report id
 631       `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
 632     },
 633     ...
 634   ]
 635 ```
 636
 637 - Response:
 638   - On failure:
 639     - 400 Bad Request, JSON:
 640
 641     ```json
 642       [
 643         {
 644           `id`, // report id
 645           `error` // error message
 646         }
 647       ]
 648     ```
 649
 650   - On success: `204`, empty response
 651
 652 ## `POST /api/pleroma/admin/reports/:id/notes`
 653
 654 ### Create report note
 655
 656 - Params:
 657   - `id`: required, report id
 658   - `content`: required, the message
 659 - Response:
 660   - On failure:
 661     - 400 Bad Request `"Invalid parameters"` when `status` is missing
 662   - On success: `204`, empty response
 663
 664 ## `POST /api/pleroma/admin/reports/:report_id/notes/:id`
 665
 666 ### Delete report note
 667
 668 - Params:
 669   - `report_id`: required, report id
 670   - `id`: required, note id
 671 - Response:
 672   - On failure:
 673     - 400 Bad Request `"Invalid parameters"` when `status` is missing
 674   - On success: `204`, empty response
 675
 676 ## `PUT /api/pleroma/admin/statuses/:id`
 677
 678 ### Change the scope of an individual reported status
 679
 680 - Params:
 681   - `id`
 682   - `sensitive`: optional, valid values are `true` or `false`
 683   - `visibility`: optional, valid values are `public`, `private` and `unlisted`
 684 - Response:
 685   - On failure:
 686     - 400 Bad Request `"Unsupported visibility"`
 687     - 403 Forbidden `{"error": "error_msg"}`
 688     - 404 Not Found `"Not found"`
 689   - On success: JSON, Mastodon Status entity
 690
 691 ## `DELETE /api/pleroma/admin/statuses/:id`
 692
 693 ### Delete an individual reported status
 694
 695 - Params:
 696   - `id`
 697 - Response:
 698   - On failure:
 699     - 403 Forbidden `{"error": "error_msg"}`
 700     - 404 Not Found `"Not found"`
 701   - On success: 200 OK `{}`
 702
 703 ## `GET /api/pleroma/admin/restart`
 704
 705 ### Restarts pleroma application
 706
 707 - Params: none
 708 - Response:
 709   - On failure:
 710     - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
 711
 712 ```json
 713 {}
 714 ```
 715
 716 ## `GET /api/pleroma/admin/config`
 717
 718 ### Get list of merged default settings with saved in database.
 719
 720 *If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
 721
 722 **Only works when configuration from database is enabled.**
 723
 724 - Params:
 725   - `only_db`: true (*optional*, get only saved in database settings)
 726 - Response:
 727   - On failure:
 728     - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
 729
 730 ```json
 731 {
 732   "configs": [
 733     {
 734       "group": ":pleroma",
 735       "key": "Pleroma.Upload",
 736       "value": []
 737      }
 738   ],
 739   "need_reboot": true
 740 }
 741 ```
 742  need_reboot - *optional*, if were changed reboot time settings.
 743
 744 ## `POST /api/pleroma/admin/config`
 745
 746 ### Update config settings
 747
 748 *If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
 749
 750 **Only works when configuration from database is enabled.**
 751
 752 Some modifications are necessary to save the config settings correctly:
 753
 754 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
 755 ```
 756 "Pleroma.Upload" -> Pleroma.Upload
 757 "Oban" -> Oban
 758 ```
 759 - strings starting with `:` will be converted to atoms;
 760 ```
 761 ":pleroma" -> :pleroma
 762 ```
 763 - objects with `tuple` key and array value will be converted to tuples;
 764 ```
 765 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
 766 ```
 767 - arrays with *tuple objects* will be converted to keywords;
 768 ```
 769 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
 770 ```
 771
 772 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:
 773 - all settings inside these keys:
 774   - `:hackney_pools`
 775   - `:chat`
 776 - partially settings inside these keys:
 777   - `:seconds_valid` in `Pleroma.Captcha`
 778   - `:proxy_remote` in `Pleroma.Upload`
 779   - `:upload_limit` in `:instance`
 780
 781 - Params:
 782   - `configs` - array of config objects
 783   - config object params:
 784     - `group` - string (**required**)
 785     - `key` - string (**required**)
 786     - `value` - string, [], {} or {"tuple": []} (**required**)
 787     - `delete` - true (*optional*, if setting must be deleted)
 788     - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
 789
 790 *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.*
 791 ```
 792 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
 793 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
 794 [subkey2: val2] \\ value after deletion
 795 ```
 796
 797 *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.*
 798
 799 Example of setting without keyword in value:
 800 ```elixir
 801 config :tesla, :adapter, Tesla.Adapter.Hackney
 802 ```
 803
 804 List of settings which support only full update by key:
 805 ```elixir
 806 @full_key_update [
 807     {:pleroma, :ecto_repos},
 808     {:quack, :meta},
 809     {:mime, :types},
 810     {:cors_plug, [:max_age, :methods, :expose, :headers]},
 811     {:auto_linker, :opts},
 812     {:swarm, :node_blacklist},
 813     {:logger, :backends}
 814   ]
 815 ```
 816
 817 List of settings which support only full update by subkey:
 818 ```elixir
 819 @full_subkey_update [
 820     {:pleroma, :assets, :mascots},
 821     {:pleroma, :emoji, :groups},
 822     {:pleroma, :workers, :retries},
 823     {:pleroma, :mrf_subchain, :match_actor},
 824     {:pleroma, :mrf_keyword, :replace}
 825   ]
 826 ```
 827
 828 *Settings without explicit key must be sended in separate config object params.*
 829 ```elixir
 830 config :quack,
 831   level: :debug,
 832   meta: [:all],
 833   ...
 834 ```
 835 ```json
 836 {
 837   "configs": [
 838     {"group": ":quack", "key": ":level", "value": ":debug"},
 839     {"group": ":quack", "key": ":meta", "value": [":all"]},
 840     ...
 841   ]
 842 }
 843 ```
 844 - Request:
 845
 846 ```json
 847 {
 848   "configs": [
 849     {
 850       "group": ":pleroma",
 851       "key": "Pleroma.Upload",
 852       "value": [
 853         {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
 854         {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
 855         {"tuple": [":link_name", true]},
 856         {"tuple": [":proxy_remote", false]},
 857         {"tuple": [":proxy_opts", [
 858           {"tuple": [":redirect_on_failure", false]},
 859           {"tuple": [":max_body_length", 1048576]},
 860           {"tuple": [":http", [
 861             {"tuple": [":follow_redirect", true]},
 862             {"tuple": [":pool", ":upload"]},
 863           ]]}
 864         ]
 865         ]},
 866         {"tuple": [":dispatch", {
 867           "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
 868         }]}
 869       ]
 870     }
 871   ]
 872 }
 873 ```
 874
 875 - Response:
 876   - On failure:
 877     - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
 878 ```json
 879 {
 880   "configs": [
 881     {
 882       "group": ":pleroma",
 883       "key": "Pleroma.Upload",
 884       "value": [...]
 885      }
 886   ],
 887   "need_reboot": true
 888 }
 889 ```
 890 need_reboot - *optional*, if were changed reboot time settings.
 891
 892 ## ` GET /api/pleroma/admin/config/descriptions`
 893
 894 ### Get JSON with config descriptions.
 895 Loads json generated from `config/descriptions.exs`.
 896
 897 - Params: none
 898 - Response:
 899
 900 ```json
 901 [{
 902     "group": ":pleroma", // string
 903     "key": "ModuleName", // string
 904     "type": "group", // string or list with possible values,
 905     "description": "Upload general settings", // string
 906     "children": [
 907       {
 908         "key": ":uploader", // string or module name `Pleroma.Upload`
 909         "type": "module",
 910         "description": "Module which will be used for uploads",
 911         "suggestions": ["module1", "module2"]
 912       },
 913       {
 914         "key": ":filters",
 915         "type": ["list", "module"],
 916         "description": "List of filter modules for uploads",
 917         "suggestions": [
 918           "module1", "module2", "module3"
 919         ]
 920       }
 921     ]
 922 }]
 923 ```
 924
 925 ## `GET /api/pleroma/admin/moderation_log`
 926
 927 ### Get moderation log
 928
 929 - Params:
 930   - *optional* `page`: **integer** page number
 931   - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
 932   - *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`
 933   - *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
 934   - *optional* `user_id`: **integer** filter logs by actor's id
 935   - *optional* `search`: **string** search logs by the log message
 936 - Response:
 937
 938 ```json
 939 [
 940   {
 941     "data": {
 942       "actor": {
 943         "id": 1,
 944         "nickname": "lain"
 945       },
 946       "action": "relay_follow"
 947     },
 948     "time": 1502812026, // timestamp
 949     "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
 950   }
 951 ]
 952 ```
 953
 954 ## `POST /api/pleroma/admin/reload_emoji`
 955
 956 ### Reload the instance's custom emoji
 957
 958 - Authentication: required
 959 - Params: None
 960 - Response: JSON, "ok" and 200 status
 961
 962 ## `PATCH /api/pleroma/admin/users/confirm_email`
 963
 964 ### Confirm users' emails
 965
 966 - Params:
 967   - `nicknames`
 968 - Response: Array of user nicknames
 969
 970 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
 971
 972 ### Resend confirmation email
 973
 974 - Params:
 975   - `nicknames`
 976 - Response: Array of user nicknames
 977
 978 ## `GET /api/pleroma/admin/stats`
 979
 980 ### Stats
 981
 982 - Response:
 983
 984 ```json
 985 {
 986   "status_visibility": {
 987     "direct": 739,
 988     "private": 9,
 989     "public": 17,
 990     "unlisted": 14
 991   }
 992 }
 993 ```