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 ## `GET /api/pleroma/admin/users/:nickname/credentials`
 418
 419 ### Get the user's email, password, display and settings-related fields
 420
 421 - Params:
 422   - `nickname`
 423
 424 - Response:
 425
 426 ```json
 427 {
 428   "actor_type": "Person",
 429   "allow_following_move": true,
 430   "avatar": "https://pleroma.social/media/7e8e7508fd545ef580549b6881d80ec0ff2c81ed9ad37b9bdbbdf0e0d030159d.jpg",
 431   "background": "https://pleroma.social/media/4de34c0bd10970d02cbdef8972bef0ebbf55f43cadc449554d4396156162fe9a.jpg",
 432   "banner": "https://pleroma.social/media/8d92ba2bd244b613520abf557dd448adcd30f5587022813ee9dd068945986946.jpg",
 433   "bio": "bio",
 434   "default_scope": "public",
 435   "discoverable": false,
 436   "email": "user@example.com",
 437   "fields": [
 438     {
 439       "name": "example",
 440       "value": "<a href=\"https://example.com\" rel=\"ugc\">https://example.com</a>"
 441     }
 442   ],
 443   "hide_favorites": false,
 444   "hide_followers": false,
 445   "hide_followers_count": false,
 446   "hide_follows": false,
 447   "hide_follows_count": false,
 448   "id": "9oouHaEEUR54hls968",
 449   "locked": true,
 450   "name": "user",
 451   "no_rich_text": true,
 452   "pleroma_settings_store": {},
 453   "raw_fields": [
 454     {
 455       "id": 1,
 456       "name": "example",
 457       "value": "https://example.com"
 458     },
 459   ],
 460   "show_role": true,
 461   "skip_thread_containment": false
 462 }
 463 ```
 464
 465 ## `PATCH /api/pleroma/admin/users/:nickname/credentials`
 466
 467 ### Change the user's email, password, display and settings-related fields
 468
 469 - Params:
 470   - `email`
 471   - `password`
 472   - `name`
 473   - `bio`
 474   - `avatar`
 475   - `locked`
 476   - `no_rich_text`
 477   - `default_scope`
 478   - `banner`
 479   - `hide_follows`
 480   - `hide_followers`
 481   - `hide_followers_count`
 482   - `hide_follows_count`
 483   - `hide_favorites`
 484   - `allow_following_move`
 485   - `background`
 486   - `show_role`
 487   - `skip_thread_containment`
 488   - `fields`
 489   - `discoverable`
 490   - `actor_type`
 491
 492 - Response: none (code `200`)
 493
 494 ## `GET /api/pleroma/admin/reports`
 495
 496 ### Get a list of reports
 497
 498 - Params:
 499   - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
 500   - *optional* `limit`: **integer** the number of records to retrieve
 501   - *optional* `page`: **integer** page number
 502   - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
 503 - Response:
 504   - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
 505   - On success: JSON, returns a list of reports, where:
 506     - `account`: the user who has been reported
 507     - `actor`: the user who has sent the report
 508     - `statuses`: list of statuses that have been included to the report
 509
 510 ```json
 511 {
 512   "totalReports" : 1,
 513   "reports": [
 514     {
 515       "account": {
 516         "acct": "user",
 517         "avatar": "https://pleroma.example.org/images/avi.png",
 518         "avatar_static": "https://pleroma.example.org/images/avi.png",
 519         "bot": false,
 520         "created_at": "2019-04-23T17:32:04.000Z",
 521         "display_name": "User",
 522         "emojis": [],
 523         "fields": [],
 524         "followers_count": 1,
 525         "following_count": 1,
 526         "header": "https://pleroma.example.org/images/banner.png",
 527         "header_static": "https://pleroma.example.org/images/banner.png",
 528         "id": "9i6dAJqSGSKMzLG2Lo",
 529         "locked": false,
 530         "note": "",
 531         "pleroma": {
 532           "confirmation_pending": false,
 533           "hide_favorites": true,
 534           "hide_followers": false,
 535           "hide_follows": false,
 536           "is_admin": false,
 537           "is_moderator": false,
 538           "relationship": {},
 539           "tags": []
 540         },
 541         "source": {
 542           "note": "",
 543           "pleroma": {},
 544           "sensitive": false
 545         },
 546         "tags": ["force_unlisted"],
 547         "statuses_count": 3,
 548         "url": "https://pleroma.example.org/users/user",
 549         "username": "user"
 550       },
 551       "actor": {
 552         "acct": "lain",
 553         "avatar": "https://pleroma.example.org/images/avi.png",
 554         "avatar_static": "https://pleroma.example.org/images/avi.png",
 555         "bot": false,
 556         "created_at": "2019-03-28T17:36:03.000Z",
 557         "display_name": "Roger Braun",
 558         "emojis": [],
 559         "fields": [],
 560         "followers_count": 1,
 561         "following_count": 1,
 562         "header": "https://pleroma.example.org/images/banner.png",
 563         "header_static": "https://pleroma.example.org/images/banner.png",
 564         "id": "9hEkA5JsvAdlSrocam",
 565         "locked": false,
 566         "note": "",
 567         "pleroma": {
 568           "confirmation_pending": false,
 569           "hide_favorites": false,
 570           "hide_followers": false,
 571           "hide_follows": false,
 572           "is_admin": false,
 573           "is_moderator": false,
 574           "relationship": {},
 575           "tags": []
 576         },
 577         "source": {
 578           "note": "",
 579           "pleroma": {},
 580           "sensitive": false
 581         },
 582         "tags": ["force_unlisted"],
 583         "statuses_count": 1,
 584         "url": "https://pleroma.example.org/users/lain",
 585         "username": "lain"
 586       },
 587       "content": "Please delete it",
 588       "created_at": "2019-04-29T19:48:15.000Z",
 589       "id": "9iJGOv1j8hxuw19bcm",
 590       "state": "open",
 591       "statuses": [
 592         {
 593           "account": { ... },
 594           "application": {
 595             "name": "Web",
 596             "website": null
 597           },
 598           "bookmarked": false,
 599           "card": null,
 600           "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>",
 601           "created_at": "2019-04-23T19:15:47.000Z",
 602           "emojis": [],
 603           "favourited": false,
 604           "favourites_count": 0,
 605           "id": "9i6mQ9uVrrOmOime8m",
 606           "in_reply_to_account_id": null,
 607           "in_reply_to_id": null,
 608           "language": null,
 609           "media_attachments": [],
 610           "mentions": [
 611             {
 612               "acct": "lain",
 613               "id": "9hEkA5JsvAdlSrocam",
 614               "url": "https://pleroma.example.org/users/lain",
 615               "username": "lain"
 616             },
 617             {
 618               "acct": "user",
 619               "id": "9i6dAJqSGSKMzLG2Lo",
 620               "url": "https://pleroma.example.org/users/user",
 621               "username": "user"
 622             }
 623           ],
 624           "muted": false,
 625           "pinned": false,
 626           "pleroma": {
 627             "content": {
 628               "text/plain": "@lain click on my link https://www.google.com/"
 629             },
 630             "conversation_id": 28,
 631             "in_reply_to_account_acct": null,
 632             "local": true,
 633             "spoiler_text": {
 634               "text/plain": ""
 635             }
 636           },
 637           "reblog": null,
 638           "reblogged": false,
 639           "reblogs_count": 0,
 640           "replies_count": 0,
 641           "sensitive": false,
 642           "spoiler_text": "",
 643           "tags": [],
 644           "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
 645           "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
 646           "visibility": "direct"
 647         }
 648       ]
 649     }
 650   ]
 651 }
 652 ```
 653
 654 ## `GET /api/pleroma/admin/grouped_reports`
 655
 656 ### Get a list of reports, grouped by status
 657
 658 - Params: none
 659 - On success: JSON, returns a list of reports, where:
 660   - `date`: date of the latest report
 661   - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
 662   - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
 663   - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
 664   - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
 665
 666 ```json
 667   "reports": [
 668     {
 669       "date": "2019-10-07T12:31:39.615149Z",
 670       "account": { ... },
 671       "status": { ... },
 672       "actors": [{ ... }, { ... }],
 673       "reports": [{ ... }]
 674     }
 675   ]
 676 ```
 677
 678 ## `GET /api/pleroma/admin/reports/:id`
 679
 680 ### Get an individual report
 681
 682 - Params:
 683   - `id`
 684 - Response:
 685   - On failure:
 686     - 403 Forbidden `{"error": "error_msg"}`
 687     - 404 Not Found `"Not found"`
 688   - On success: JSON, Report object (see above)
 689
 690 ## `PATCH /api/pleroma/admin/reports`
 691
 692 ### Change the state of one or multiple reports
 693
 694 - Params:
 695
 696 ```json
 697   `reports`: [
 698     {
 699       `id`, // required, report id
 700       `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
 701     },
 702     ...
 703   ]
 704 ```
 705
 706 - Response:
 707   - On failure:
 708     - 400 Bad Request, JSON:
 709
 710     ```json
 711       [
 712         {
 713           `id`, // report id
 714           `error` // error message
 715         }
 716       ]
 717     ```
 718
 719   - On success: `204`, empty response
 720
 721 ## `POST /api/pleroma/admin/reports/:id/notes`
 722
 723 ### Create report note
 724
 725 - Params:
 726   - `id`: required, report id
 727   - `content`: required, the message
 728 - Response:
 729   - On failure:
 730     - 400 Bad Request `"Invalid parameters"` when `status` is missing
 731   - On success: `204`, empty response
 732
 733 ## `POST /api/pleroma/admin/reports/:report_id/notes/:id`
 734
 735 ### Delete report note
 736
 737 - Params:
 738   - `report_id`: required, report id
 739   - `id`: required, note id
 740 - Response:
 741   - On failure:
 742     - 400 Bad Request `"Invalid parameters"` when `status` is missing
 743   - On success: `204`, empty response
 744
 745 ## `PUT /api/pleroma/admin/statuses/:id`
 746
 747 ### Change the scope of an individual reported status
 748
 749 - Params:
 750   - `id`
 751   - `sensitive`: optional, valid values are `true` or `false`
 752   - `visibility`: optional, valid values are `public`, `private` and `unlisted`
 753 - Response:
 754   - On failure:
 755     - 400 Bad Request `"Unsupported visibility"`
 756     - 403 Forbidden `{"error": "error_msg"}`
 757     - 404 Not Found `"Not found"`
 758   - On success: JSON, Mastodon Status entity
 759
 760 ## `DELETE /api/pleroma/admin/statuses/:id`
 761
 762 ### Delete an individual reported status
 763
 764 - Params:
 765   - `id`
 766 - Response:
 767   - On failure:
 768     - 403 Forbidden `{"error": "error_msg"}`
 769     - 404 Not Found `"Not found"`
 770   - On success: 200 OK `{}`
 771
 772 ## `GET /api/pleroma/admin/restart`
 773
 774 ### Restarts pleroma application
 775
 776 - Params: none
 777 - Response:
 778   - On failure:
 779     - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
 780
 781 ```json
 782 {}
 783 ```
 784
 785 ## `GET /api/pleroma/admin/config`
 786
 787 ### Get list of merged default settings with saved in database.
 788
 789 *If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
 790
 791 **Only works when configuration from database is enabled.**
 792
 793 - Params:
 794   - `only_db`: true (*optional*, get only saved in database settings)
 795 - Response:
 796   - On failure:
 797     - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
 798
 799 ```json
 800 {
 801   "configs": [
 802     {
 803       "group": ":pleroma",
 804       "key": "Pleroma.Upload",
 805       "value": []
 806      }
 807   ],
 808   "need_reboot": true
 809 }
 810 ```
 811  need_reboot - *optional*, if were changed reboot time settings.
 812
 813 ## `POST /api/pleroma/admin/config`
 814
 815 ### Update config settings
 816
 817 *If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.*
 818
 819 **Only works when configuration from database is enabled.**
 820
 821 Some modifications are necessary to save the config settings correctly:
 822
 823 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
 824 ```
 825 "Pleroma.Upload" -> Pleroma.Upload
 826 "Oban" -> Oban
 827 ```
 828 - strings starting with `:` will be converted to atoms;
 829 ```
 830 ":pleroma" -> :pleroma
 831 ```
 832 - objects with `tuple` key and array value will be converted to tuples;
 833 ```
 834 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
 835 ```
 836 - arrays with *tuple objects* will be converted to keywords;
 837 ```
 838 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
 839 ```
 840
 841 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:
 842 - all settings inside these keys:
 843   - `:hackney_pools`
 844   - `:chat`
 845 - partially settings inside these keys:
 846   - `:seconds_valid` in `Pleroma.Captcha`
 847   - `:proxy_remote` in `Pleroma.Upload`
 848   - `:upload_limit` in `:instance`
 849
 850 - Params:
 851   - `configs` - array of config objects
 852   - config object params:
 853     - `group` - string (**required**)
 854     - `key` - string (**required**)
 855     - `value` - string, [], {} or {"tuple": []} (**required**)
 856     - `delete` - true (*optional*, if setting must be deleted)
 857     - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
 858
 859 *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.*
 860 ```
 861 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
 862 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
 863 [subkey2: val2] \\ value after deletion
 864 ```
 865
 866 *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.*
 867
 868 Example of setting without keyword in value:
 869 ```elixir
 870 config :tesla, :adapter, Tesla.Adapter.Hackney
 871 ```
 872
 873 List of settings which support only full update by key:
 874 ```elixir
 875 @full_key_update [
 876     {:pleroma, :ecto_repos},
 877     {:quack, :meta},
 878     {:mime, :types},
 879     {:cors_plug, [:max_age, :methods, :expose, :headers]},
 880     {:auto_linker, :opts},
 881     {:swarm, :node_blacklist},
 882     {:logger, :backends}
 883   ]
 884 ```
 885
 886 List of settings which support only full update by subkey:
 887 ```elixir
 888 @full_subkey_update [
 889     {:pleroma, :assets, :mascots},
 890     {:pleroma, :emoji, :groups},
 891     {:pleroma, :workers, :retries},
 892     {:pleroma, :mrf_subchain, :match_actor},
 893     {:pleroma, :mrf_keyword, :replace}
 894   ]
 895 ```
 896
 897 *Settings without explicit key must be sended in separate config object params.*
 898 ```elixir
 899 config :quack,
 900   level: :debug,
 901   meta: [:all],
 902   ...
 903 ```
 904 ```json
 905 {
 906   "configs": [
 907     {"group": ":quack", "key": ":level", "value": ":debug"},
 908     {"group": ":quack", "key": ":meta", "value": [":all"]},
 909     ...
 910   ]
 911 }
 912 ```
 913 - Request:
 914
 915 ```json
 916 {
 917   "configs": [
 918     {
 919       "group": ":pleroma",
 920       "key": "Pleroma.Upload",
 921       "value": [
 922         {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
 923         {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
 924         {"tuple": [":link_name", true]},
 925         {"tuple": [":proxy_remote", false]},
 926         {"tuple": [":proxy_opts", [
 927           {"tuple": [":redirect_on_failure", false]},
 928           {"tuple": [":max_body_length", 1048576]},
 929           {"tuple": [":http", [
 930             {"tuple": [":follow_redirect", true]},
 931             {"tuple": [":pool", ":upload"]},
 932           ]]}
 933         ]
 934         ]},
 935         {"tuple": [":dispatch", {
 936           "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
 937         }]}
 938       ]
 939     }
 940   ]
 941 }
 942 ```
 943
 944 - Response:
 945   - On failure:
 946     - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
 947 ```json
 948 {
 949   "configs": [
 950     {
 951       "group": ":pleroma",
 952       "key": "Pleroma.Upload",
 953       "value": [...]
 954      }
 955   ],
 956   "need_reboot": true
 957 }
 958 ```
 959 need_reboot - *optional*, if were changed reboot time settings.
 960
 961 ## ` GET /api/pleroma/admin/config/descriptions`
 962
 963 ### Get JSON with config descriptions.
 964 Loads json generated from `config/descriptions.exs`.
 965
 966 - Params: none
 967 - Response:
 968
 969 ```json
 970 [{
 971     "group": ":pleroma", // string
 972     "key": "ModuleName", // string
 973     "type": "group", // string or list with possible values,
 974     "description": "Upload general settings", // string
 975     "children": [
 976       {
 977         "key": ":uploader", // string or module name `Pleroma.Upload`
 978         "type": "module",
 979         "description": "Module which will be used for uploads",
 980         "suggestions": ["module1", "module2"]
 981       },
 982       {
 983         "key": ":filters",
 984         "type": ["list", "module"],
 985         "description": "List of filter modules for uploads",
 986         "suggestions": [
 987           "module1", "module2", "module3"
 988         ]
 989       }
 990     ]
 991 }]
 992 ```
 993
 994 ## `GET /api/pleroma/admin/moderation_log`
 995
 996 ### Get moderation log
 997
 998 - Params:
 999   - *optional* `page`: **integer** page number
1000   - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
1001   - *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`
1002   - *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
1003   - *optional* `user_id`: **integer** filter logs by actor's id
1004   - *optional* `search`: **string** search logs by the log message
1005 - Response:
1006
1007 ```json
1008 [
1009   {
1010     "data": {
1011       "actor": {
1012         "id": 1,
1013         "nickname": "lain"
1014       },
1015       "action": "relay_follow"
1016     },
1017     "time": 1502812026, // timestamp
1018     "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
1019   }
1020 ]
1021 ```
1022
1023 ## `POST /api/pleroma/admin/reload_emoji`
1024
1025 ### Reload the instance's custom emoji
1026
1027 - Authentication: required
1028 - Params: None
1029 - Response: JSON, "ok" and 200 status
1030
1031 ## `PATCH /api/pleroma/admin/users/confirm_email`
1032
1033 ### Confirm users' emails
1034
1035 - Params:
1036   - `nicknames`
1037 - Response: Array of user nicknames
1038
1039 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
1040
1041 ### Resend confirmation email
1042
1043 - Params:
1044   - `nicknames`
1045 - Response: Array of user nicknames
1046
1047 ## `GET /api/pleroma/admin/stats`
1048
1049 ### Stats
1050
1051 - Response:
1052
1053 ```json
1054 {
1055   "status_visibility": {
1056     "direct": 739,
1057     "private": 9,
1058     "public": 17,
1059     "unlisted": 14
1060   }
1061 }
1062 ```