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 - Response:
 264   - On failure: `Not found`
 265   - On success: JSON array of user's latest statuses
 266
 267 ## `POST /api/pleroma/admin/relay`
 268
 269 ### Follow a Relay
 270
 271 - Params:
 272   - `relay_url`
 273 - Response:
 274   - On success: URL of the followed relay
 275
 276 ## `DELETE /api/pleroma/admin/relay`
 277
 278 ### Unfollow a Relay
 279
 280 - Params:
 281   - `relay_url`
 282 - Response:
 283   - On success: URL of the unfollowed relay
 284
 285 ## `GET /api/pleroma/admin/relay`
 286
 287 ### List Relays
 288
 289 - Params: none
 290 - Response:
 291   - On success: JSON array of relays
 292
 293 ## `POST /api/pleroma/admin/users/invite_token`
 294
 295 ### Create an account registration invite token
 296
 297 - Params:
 298   - *optional* `max_use` (integer)
 299   - *optional* `expires_at` (date string e.g. "2019-04-07")
 300 - Response:
 301
 302 ```json
 303 {
 304   "id": integer,
 305   "token": string,
 306   "used": boolean,
 307   "expires_at": date,
 308   "uses": integer,
 309   "max_use": integer,
 310   "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
 311 }
 312 ```
 313
 314 ## `GET /api/pleroma/admin/users/invites`
 315
 316 ### Get a list of generated invites
 317
 318 - Params: none
 319 - Response:
 320
 321 ```json
 322 {
 323
 324   "invites": [
 325     {
 326       "id": integer,
 327       "token": string,
 328       "used": boolean,
 329       "expires_at": date,
 330       "uses": integer,
 331       "max_use": integer,
 332       "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
 333     },
 334     ...
 335   ]
 336 }
 337 ```
 338
 339 ## `POST /api/pleroma/admin/users/revoke_invite`
 340
 341 ### Revoke invite by token
 342
 343 - Params:
 344   - `token`
 345 - Response:
 346
 347 ```json
 348 {
 349   "id": integer,
 350   "token": string,
 351   "used": boolean,
 352   "expires_at": date,
 353   "uses": integer,
 354   "max_use": integer,
 355   "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
 356
 357 }
 358 ```
 359
 360 ## `POST /api/pleroma/admin/users/email_invite`
 361
 362 ### Sends registration invite via email
 363
 364 - Params:
 365   - `email`
 366   - `name`, optional
 367
 368 ## `GET /api/pleroma/admin/users/:nickname/password_reset`
 369
 370 ### Get a password reset token for a given nickname
 371
 372 - Params: none
 373 - Response:
 374
 375 ```json
 376 {
 377   "token": "base64 reset token",
 378   "link": "https://pleroma.social/api/pleroma/password_reset/url-encoded-base64-token"
 379 }
 380 ```
 381
 382 ## `PATCH /api/pleroma/admin/users/force_password_reset`
 383
 384 ### Force passord reset for a user with a given nickname
 385
 386 - Params:
 387   - `nicknames`
 388 - Response: none (code `204`)
 389
 390 ## `GET /api/pleroma/admin/reports`
 391
 392 ### Get a list of reports
 393
 394 - Params:
 395   - *optional* `state`: **string** the state of reports. Valid values are `open`, `closed` and `resolved`
 396   - *optional* `limit`: **integer** the number of records to retrieve
 397   - *optional* `page`: **integer** page number
 398   - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
 399 - Response:
 400   - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
 401   - On success: JSON, returns a list of reports, where:
 402     - `account`: the user who has been reported
 403     - `actor`: the user who has sent the report
 404     - `statuses`: list of statuses that have been included to the report
 405
 406 ```json
 407 {
 408   "totalReports" : 1,
 409   "reports": [
 410     {
 411       "account": {
 412         "acct": "user",
 413         "avatar": "https://pleroma.example.org/images/avi.png",
 414         "avatar_static": "https://pleroma.example.org/images/avi.png",
 415         "bot": false,
 416         "created_at": "2019-04-23T17:32:04.000Z",
 417         "display_name": "User",
 418         "emojis": [],
 419         "fields": [],
 420         "followers_count": 1,
 421         "following_count": 1,
 422         "header": "https://pleroma.example.org/images/banner.png",
 423         "header_static": "https://pleroma.example.org/images/banner.png",
 424         "id": "9i6dAJqSGSKMzLG2Lo",
 425         "locked": false,
 426         "note": "",
 427         "pleroma": {
 428           "confirmation_pending": false,
 429           "hide_favorites": true,
 430           "hide_followers": false,
 431           "hide_follows": false,
 432           "is_admin": false,
 433           "is_moderator": false,
 434           "relationship": {},
 435           "tags": []
 436         },
 437         "source": {
 438           "note": "",
 439           "pleroma": {},
 440           "sensitive": false
 441         },
 442         "tags": ["force_unlisted"],
 443         "statuses_count": 3,
 444         "url": "https://pleroma.example.org/users/user",
 445         "username": "user"
 446       },
 447       "actor": {
 448         "acct": "lain",
 449         "avatar": "https://pleroma.example.org/images/avi.png",
 450         "avatar_static": "https://pleroma.example.org/images/avi.png",
 451         "bot": false,
 452         "created_at": "2019-03-28T17:36:03.000Z",
 453         "display_name": "Roger Braun",
 454         "emojis": [],
 455         "fields": [],
 456         "followers_count": 1,
 457         "following_count": 1,
 458         "header": "https://pleroma.example.org/images/banner.png",
 459         "header_static": "https://pleroma.example.org/images/banner.png",
 460         "id": "9hEkA5JsvAdlSrocam",
 461         "locked": false,
 462         "note": "",
 463         "pleroma": {
 464           "confirmation_pending": false,
 465           "hide_favorites": false,
 466           "hide_followers": false,
 467           "hide_follows": false,
 468           "is_admin": false,
 469           "is_moderator": false,
 470           "relationship": {},
 471           "tags": []
 472         },
 473         "source": {
 474           "note": "",
 475           "pleroma": {},
 476           "sensitive": false
 477         },
 478         "tags": ["force_unlisted"],
 479         "statuses_count": 1,
 480         "url": "https://pleroma.example.org/users/lain",
 481         "username": "lain"
 482       },
 483       "content": "Please delete it",
 484       "created_at": "2019-04-29T19:48:15.000Z",
 485       "id": "9iJGOv1j8hxuw19bcm",
 486       "state": "open",
 487       "statuses": [
 488         {
 489           "account": { ... },
 490           "application": {
 491             "name": "Web",
 492             "website": null
 493           },
 494           "bookmarked": false,
 495           "card": null,
 496           "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>",
 497           "created_at": "2019-04-23T19:15:47.000Z",
 498           "emojis": [],
 499           "favourited": false,
 500           "favourites_count": 0,
 501           "id": "9i6mQ9uVrrOmOime8m",
 502           "in_reply_to_account_id": null,
 503           "in_reply_to_id": null,
 504           "language": null,
 505           "media_attachments": [],
 506           "mentions": [
 507             {
 508               "acct": "lain",
 509               "id": "9hEkA5JsvAdlSrocam",
 510               "url": "https://pleroma.example.org/users/lain",
 511               "username": "lain"
 512             },
 513             {
 514               "acct": "user",
 515               "id": "9i6dAJqSGSKMzLG2Lo",
 516               "url": "https://pleroma.example.org/users/user",
 517               "username": "user"
 518             }
 519           ],
 520           "muted": false,
 521           "pinned": false,
 522           "pleroma": {
 523             "content": {
 524               "text/plain": "@lain click on my link https://www.google.com/"
 525             },
 526             "conversation_id": 28,
 527             "in_reply_to_account_acct": null,
 528             "local": true,
 529             "spoiler_text": {
 530               "text/plain": ""
 531             }
 532           },
 533           "reblog": null,
 534           "reblogged": false,
 535           "reblogs_count": 0,
 536           "replies_count": 0,
 537           "sensitive": false,
 538           "spoiler_text": "",
 539           "tags": [],
 540           "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
 541           "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
 542           "visibility": "direct"
 543         }
 544       ]
 545     }
 546   ]
 547 }
 548 ```
 549
 550 ## `GET /api/pleroma/admin/grouped_reports`
 551
 552 ### Get a list of reports, grouped by status
 553
 554 - Params: none
 555 - On success: JSON, returns a list of reports, where:
 556   - `date`: date of the latest report
 557   - `account`: the user who has been reported (see `/api/pleroma/admin/reports` for reference)
 558   - `status`: reported status (see `/api/pleroma/admin/reports` for reference)
 559   - `actors`: users who had reported this status (see `/api/pleroma/admin/reports` for reference)
 560   - `reports`: reports (see `/api/pleroma/admin/reports` for reference)
 561
 562 ```json
 563   "reports": [
 564     {
 565       "date": "2019-10-07T12:31:39.615149Z",
 566       "account": { ... },
 567       "status": { ... },
 568       "actors": [{ ... }, { ... }],
 569       "reports": [{ ... }]
 570     }
 571   ]
 572 ```
 573
 574 ## `GET /api/pleroma/admin/reports/:id`
 575
 576 ### Get an individual report
 577
 578 - Params:
 579   - `id`
 580 - Response:
 581   - On failure:
 582     - 403 Forbidden `{"error": "error_msg"}`
 583     - 404 Not Found `"Not found"`
 584   - On success: JSON, Report object (see above)
 585
 586 ## `PATCH /api/pleroma/admin/reports`
 587
 588 ### Change the state of one or multiple reports
 589
 590 - Params:
 591
 592 ```json
 593   `reports`: [
 594     {
 595       `id`, // required, report id
 596       `state` // required, the new state. Valid values are `open`, `closed` and `resolved`
 597     },
 598     ...
 599   ]
 600 ```
 601
 602 - Response:
 603   - On failure:
 604     - 400 Bad Request, JSON:
 605
 606     ```json
 607       [
 608         {
 609           `id`, // report id
 610           `error` // error message
 611         }
 612       ]
 613     ```
 614
 615   - On success: `204`, empty response
 616
 617 ## `POST /api/pleroma/admin/reports/:id/notes`
 618
 619 ### Create report note
 620
 621 - Params:
 622   - `id`: required, report id
 623   - `content`: required, the message
 624 - Response:
 625   - On failure:
 626     - 400 Bad Request `"Invalid parameters"` when `status` is missing
 627   - On success: `204`, empty response
 628
 629 ## `POST /api/pleroma/admin/reports/:report_id/notes/:id`
 630
 631 ### Delete report note
 632
 633 - Params:
 634   - `report_id`: required, report id
 635   - `id`: required, note id
 636 - Response:
 637   - On failure:
 638     - 400 Bad Request `"Invalid parameters"` when `status` is missing
 639   - On success: `204`, empty response
 640
 641 ## `PUT /api/pleroma/admin/statuses/:id`
 642
 643 ### Change the scope of an individual reported status
 644
 645 - Params:
 646   - `id`
 647   - `sensitive`: optional, valid values are `true` or `false`
 648   - `visibility`: optional, valid values are `public`, `private` and `unlisted`
 649 - Response:
 650   - On failure:
 651     - 400 Bad Request `"Unsupported visibility"`
 652     - 403 Forbidden `{"error": "error_msg"}`
 653     - 404 Not Found `"Not found"`
 654   - On success: JSON, Mastodon Status entity
 655
 656 ## `DELETE /api/pleroma/admin/statuses/:id`
 657
 658 ### Delete an individual reported status
 659
 660 - Params:
 661   - `id`
 662 - Response:
 663   - On failure:
 664     - 403 Forbidden `{"error": "error_msg"}`
 665     - 404 Not Found `"Not found"`
 666   - On success: 200 OK `{}`
 667
 668 ## `GET /api/pleroma/admin/config/migrate_from_db`
 669
 670 ### Run mix task pleroma.config migrate_from_db
 671
 672 Copies all settings from database to `config/{env}.exported_from_db.secret.exs` with deletion from the table. Where `{env}` is the environment in which `pleroma` is running.
 673
 674 - Params: none
 675 - Response:
 676   - On failure:
 677     - 400 Bad Request `"To use this endpoint you need to enable dynamic configuration."`
 678
 679 ```json
 680 {}
 681 ```
 682
 683 ## `GET /api/pleroma/admin/config`
 684
 685 ### Get saved config settings
 686
 687 **Only works when `:dynamic_configuration` is `true`.**
 688
 689 - Params: none
 690 - Response:
 691   - On failure:
 692     - 400 Bad Request `"To use this endpoint you need to enable dynamic configuration."`
 693     - 400 Bad Request `"To use dynamic configuration migrate your settings to database."`
 694
 695 ```json
 696 {
 697   configs: [
 698     {
 699       "group": ":pleroma",
 700       "key": "Pleroma.Upload",
 701       "value": []
 702      }
 703   ]
 704 }
 705 ```
 706
 707 ## `POST /api/pleroma/admin/config`
 708
 709 ### Update config settings
 710
 711 **Only works when `:dynamic_configuration` is `true`.**
 712
 713 Some modifications are necessary to save the config settings correctly:
 714
 715 - strings which start with `Pleroma.`, `Phoenix.`, `Tesla.` or strings like `Oban`, `Ueberauth` will be converted to modules;
 716 ```
 717 "Pleroma.Upload" -> Pleroma.Upload
 718 "Oban" -> Oban
 719 ```
 720 - strings starting with `:` will be converted to atoms;
 721 ```
 722 ":pleroma" -> :pleroma
 723 ```
 724 - objects with `tuple` key and array value will be converted to atoms;
 725 ```
 726 {"tuple": ["string", "Pleroma.Upload", []]} -> {"string", Pleroma.Upload, []}
 727 ```
 728 - arrays with *tuple objects* and 2 childs in array will be converted to keywords;
 729 ```
 730 [{"tuple": [":key1", "value"]}, {"tuple": [":key2", "value"]}] -> [key1: "value", key2: "value"]
 731 ```
 732
 733 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:
 734 - all settings inside these keys:
 735   - `:hackney_pools`
 736   - `:chat`
 737   - `Pleroma.Web.Endpoint`
 738 - partially settings inside these keys:
 739   - `:seconds_valid` in `Pleroma.Captcha`
 740   - `:proxy_remote` in `Pleroma.Upload`
 741   - `:upload_limit` in `:instance`
 742
 743 - Params:
 744   - `configs` - array of config objects
 745   - config object params:
 746     - `group` - string (**required**)
 747     - `key` - string (**required**)
 748     - `value` - string, [], {} or {"tuple": []} (**required**)
 749     - `delete` - true (*optional*, if setting must be deleted)
 750     - `subkeys` - array of strings (*optional*, only works when `delete=true` parameter is passed, otherwise will be ignored)
 751
 752 *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.*
 753 ```
 754 [subkey: val1, subkey2: val2, subkey3: val3] \\ initial value
 755 {"group": ":pleroma", "key": "some_key", "delete": true, "subkeys": [":subkey", ":subkey3"]} \\ passing json for deletion
 756 [subkey2: val2] \\ value after deletion
 757 ```
 758
 759 *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.*
 760
 761 Example of setting without keyword in value:
 762 ```elixir
 763 config :tesla, :adapter, Tesla.Adapter.Hackney
 764 ```
 765
 766 List of settings which have list in value:
 767 ```elixir
 768 @full_key_update [
 769     {:pleroma, :ecto_repos},
 770     {:quack, :meta},
 771     {:mime, :types},
 772     {:cors_plug, [:max_age, :methods, :expose, :headers]},
 773     {:auto_linker, :opts},
 774     {:swarm, :node_blacklist}
 775   ]
 776 ```
 777
 778 *Settings without explicit key must be sended in separate config object params.*
 779 ```elixir
 780 config :quack,
 781   level: :debug,
 782   meta: [:all],
 783   ...
 784 ```
 785 ```json
 786 {
 787   configs: [
 788     {"group": ":quack", "key": ":level", "value": ":debug"},
 789     {"group": ":quack", "key": ":meta", "value": [":all"]},
 790     ...
 791   ]
 792 }
 793 ```
 794 - Request:
 795
 796 ```json
 797 {
 798   configs: [
 799     {
 800       "group": ":pleroma",
 801       "key": "Pleroma.Upload",
 802       "value": [
 803         {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
 804         {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
 805         {"tuple": [":link_name", true]},
 806         {"tuple": [":proxy_remote", false]},
 807         {"tuple": [":proxy_opts", [
 808           {"tuple": [":redirect_on_failure", false]},
 809           {"tuple": [":max_body_length", 1048576]},
 810           {"tuple": [":http", [
 811             {"tuple": [":follow_redirect", true]},
 812             {"tuple": [":pool", ":upload"]},
 813           ]]}
 814         ]
 815         ]},
 816         {"tuple": [":dispatch", {
 817           "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
 818         }]}
 819       ]
 820     }
 821   ]
 822 }
 823 ```
 824
 825 - Response:
 826   - On failure:
 827     - 400 Bad Request `"To use this endpoint you need to enable dynamic configuration."`
 828 ```json
 829 {
 830   configs: [
 831     {
 832       "group": ":pleroma",
 833       "key": "Pleroma.Upload",
 834       "value": [...]
 835      }
 836   ]
 837 }
 838 ```
 839
 840 ## ` GET /api/pleroma/admin/config/descriptions`
 841
 842 ### Get JSON with config descriptions.
 843 Loads json generated from `config/descriptions.exs`.
 844
 845 - Params: none
 846 - Response:
 847
 848 ```json
 849 [{
 850     "group": ":pleroma", // string
 851     "key": "ModuleName", // string
 852     "type": "group", // string or list with possible values,
 853     "description": "Upload general settings", // string
 854     "children": [
 855       {
 856         "key": ":uploader", // string or module name `Pleroma.Upload`
 857         "type": "module",
 858         "description": "Module which will be used for uploads",
 859         "suggestions": ["module1", "module2"]
 860       },
 861       {
 862         "key": ":filters",
 863         "type": ["list", "module"],
 864         "description": "List of filter modules for uploads",
 865         "suggestions": [
 866           "module1", "module2", "module3"
 867         ]
 868       }
 869     ]
 870 }]
 871 ```
 872
 873 ## `GET /api/pleroma/admin/moderation_log`
 874
 875 ### Get moderation log
 876
 877 - Params:
 878   - *optional* `page`: **integer** page number
 879   - *optional* `page_size`: **integer** number of log entries per page (default is `50`)
 880   - *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`
 881   - *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
 882   - *optional* `user_id`: **integer** filter logs by actor's id
 883   - *optional* `search`: **string** search logs by the log message
 884 - Response:
 885
 886 ```json
 887 [
 888   {
 889     "data": {
 890       "actor": {
 891         "id": 1,
 892         "nickname": "lain"
 893       },
 894       "action": "relay_follow"
 895     },
 896     "time": 1502812026, // timestamp
 897     "message": "[2017-08-15 15:47:06] @nick0 followed relay: https://example.org/relay" // log message
 898   }
 899 ]
 900 ```
 901
 902 ## `POST /api/pleroma/admin/reload_emoji`
 903
 904 ### Reload the instance's custom emoji
 905
 906 - Authentication: required
 907 - Params: None
 908 - Response: JSON, "ok" and 200 status
 909
 910 ## `PATCH /api/pleroma/admin/users/confirm_email`
 911
 912 ### Confirm users' emails
 913
 914 - Params:
 915   - `nicknames`
 916 - Response: Array of user nicknames
 917
 918 ## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
 919
 920 ### Resend confirmation email
 921
 922 - Params:
 923   - `nicknames`
 924 - Response: Array of user nicknames