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