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

   1 # Pleroma API
   2
   3 Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).
   4
   5 Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`.
   6
   7 ## `/api/pleroma/emoji`
   8 ### Lists the custom emoji on that server.
   9 * Method: `GET`
  10 * Authentication: not required
  11 * Params: none
  12 * Response: JSON
  13 * Example response:
  14 ```json
  15 {
  16   "girlpower": {
  17     "tags": [
  18       "Finmoji"
  19     ],
  20     "image_url": "/finmoji/128px/girlpower-128.png"
  21   },
  22   "education": {
  23     "tags": [
  24       "Finmoji"
  25     ],
  26     "image_url": "/finmoji/128px/education-128.png"
  27   },
  28   "finnishlove": {
  29     "tags": [
  30       "Finmoji"
  31     ],
  32     "image_url": "/finmoji/128px/finnishlove-128.png"
  33   }
  34 }
  35 ```
  36 * Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format
  37
  38 ## `/api/pleroma/follow_import`
  39 ### Imports your follows, for example from a Mastodon CSV file.
  40 * Method: `POST`
  41 * Authentication: required
  42 * Params:
  43     * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
  44 * Response: HTTP 200 on success, 500 on error
  45 * Note: Users that can't be followed are silently skipped.
  46
  47 ## `/api/pleroma/captcha`
  48 ### Get a new captcha
  49 * Method: `GET`
  50 * Authentication: not required
  51 * Params: none
  52 * Response: Provider specific JSON, the only guaranteed parameter is `type`
  53 * Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}`
  54
  55 ## `/api/pleroma/delete_account`
  56 ### Delete an account
  57 * Method `POST`
  58 * Authentication: required
  59 * Params:
  60     * `password`: user's password
  61 * Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise
  62 * Example response: `{"error": "Invalid password."}`
  63
  64 ## `/api/pleroma/disable_account`
  65 ### Disable an account
  66 * Method `POST`
  67 * Authentication: required
  68 * Params:
  69     * `password`: user's password
  70 * Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"error": "[error message]"}` otherwise
  71 * Example response: `{"error": "Invalid password."}`
  72
  73 ## `/api/pleroma/accounts/mfa`
  74 #### Gets current MFA settings
  75 * method: `GET`
  76 * Authentication: required
  77 * OAuth scope: `read:security`
  78 * Response: JSON. Returns `{"enabled": "false", "totp": false }`
  79
  80 ## `/api/pleroma/accounts/mfa/setup/totp`
  81 #### Pre-setup the MFA/TOTP method
  82 * method: `GET`
  83 * Authentication: required
  84 * OAuth scope: `write:security`
  85 * Response: JSON. Returns `{"key": [secret_key], "provisioning_uri": "[qr code uri]"  }` when successful, otherwise returns HTTP 422 `{"error": "error_msg"}`
  86
  87 ## `/api/pleroma/accounts/mfa/confirm/totp`
  88 #### Confirms & enables MFA/TOTP support for user account.
  89 * method: `POST`
  90 * Authentication: required
  91 * OAuth scope: `write:security`
  92 * Params:
  93     * `password`: user's password
  94     * `code`: token from TOTP App
  95 * Response: JSON. Returns `{}` if the enable was successful, HTTP 422 `{"error": "[error message]"}` otherwise
  96
  97
  98 ## `/api/pleroma/accounts/mfa/totp`
  99 ####  Disables MFA/TOTP method for user account.
 100 * method: `DELETE`
 101 * Authentication: required
 102 * OAuth scope: `write:security`
 103 * Params:
 104     * `password`: user's password
 105 * Response: JSON. Returns `{}` if the disable was successful, HTTP 422 `{"error": "[error message]"}` otherwise
 106 * Example response: `{"error": "Invalid password."}`
 107
 108 ## `/api/pleroma/accounts/mfa/backup_codes`
 109 ####  Generstes backup codes MFA for user account.
 110 * method: `GET`
 111 * Authentication: required
 112 * OAuth scope: `write:security`
 113 * Response: JSON. Returns `{"codes": codes}`when successful, otherwise HTTP 422 `{"error": "[error message]"}`
 114
 115 ## `/api/pleroma/admin/`
 116 See [Admin-API](admin_api.md)
 117
 118 ## `/api/v1/pleroma/notifications/read`
 119 ### Mark notifications as read
 120 * Method `POST`
 121 * Authentication: required
 122 * Params (mutually exclusive):
 123     * `id`: a single notification id to read
 124     * `max_id`: read all notifications up to this id
 125 * Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned.
 126
 127 ## `/api/v1/pleroma/accounts/:id/subscribe`
 128 ### Subscribe to receive notifications for all statuses posted by a user
 129 * Method `POST`
 130 * Authentication: required
 131 * Params:
 132     * `id`: account id to subscribe to
 133 * Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
 134 * Example response:
 135 ```json
 136 {
 137   "id": "abcdefg",
 138   "following": true,
 139   "followed_by": false,
 140   "blocking": false,
 141   "muting": false,
 142   "muting_notifications": false,
 143   "subscribing": true,
 144   "requested": false,
 145   "domain_blocking": false,
 146   "showing_reblogs": true,
 147   "endorsed": false
 148 }
 149 ```
 150
 151 ## `/api/v1/pleroma/accounts/:id/unsubscribe`
 152 ### Unsubscribe to stop receiving notifications from user statuses
 153 * Method `POST`
 154 * Authentication: required
 155 * Params:
 156     * `id`: account id to unsubscribe from
 157 * Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
 158 * Example response:
 159 ```json
 160 {
 161   "id": "abcdefg",
 162   "following": true,
 163   "followed_by": false,
 164   "blocking": false,
 165   "muting": false,
 166   "muting_notifications": false,
 167   "subscribing": false,
 168   "requested": false,
 169   "domain_blocking": false,
 170   "showing_reblogs": true,
 171   "endorsed": false
 172 }
 173 ```
 174
 175 ## `/api/v1/pleroma/accounts/:id/favourites`
 176 ### Returns favorites timeline of any user
 177 * Method `GET`
 178 * Authentication: not required
 179 * Params:
 180     * `id`: the id of the account for whom to return results
 181     * `limit`: optional, the number of records to retrieve
 182     * `since_id`: optional, returns results that are more recent than the specified id
 183     * `max_id`: optional, returns results that are older than the specified id
 184 * Response: JSON, returns a list of Mastodon Status entities on success, otherwise returns `{"error": "error_msg"}`
 185 * Example response:
 186 ```json
 187 [
 188   {
 189     "account": {
 190       "id": "9hptFmUF3ztxYh3Svg",
 191       "url": "https://pleroma.example.org/users/nick2",
 192       "username": "nick2",
 193       ...
 194     },
 195     "application": {"name": "Web", "website": null},
 196     "bookmarked": false,
 197     "card": null,
 198     "content": "This is :moominmamma: note 0",
 199     "created_at": "2019-04-15T15:42:15.000Z",
 200     "emojis": [],
 201     "favourited": false,
 202     "favourites_count": 1,
 203     "id": "9hptFmVJ02khbzYJaS",
 204     "in_reply_to_account_id": null,
 205     "in_reply_to_id": null,
 206     "language": null,
 207     "media_attachments": [],
 208     "mentions": [],
 209     "muted": false,
 210     "pinned": false,
 211     "pleroma": {
 212       "content": {"text/plain": "This is :moominmamma: note 0"},
 213       "conversation_id": 13679,
 214       "local": true,
 215       "spoiler_text": {"text/plain": "2hu"}
 216     },
 217     "reblog": null,
 218     "reblogged": false,
 219     "reblogs_count": 0,
 220     "replies_count": 0,
 221     "sensitive": false,
 222     "spoiler_text": "2hu",
 223     "tags": [{"name": "2hu", "url": "/tag/2hu"}],
 224     "uri": "https://pleroma.example.org/objects/198ed2a1-7912-4482-b559-244a0369e984",
 225     "url": "https://pleroma.example.org/notice/9hptFmVJ02khbzYJaS",
 226     "visibility": "public"
 227   }
 228 ]
 229 ```
 230
 231 ## `/api/v1/pleroma/accounts/update_*`
 232 ### Set and clear account avatar, banner, and background
 233
 234 - PATCH `/api/v1/pleroma/accounts/update_avatar`: Set/clear user avatar image
 235 - PATCH `/api/v1/pleroma/accounts/update_banner`: Set/clear user banner image
 236 - PATCH `/api/v1/pleroma/accounts/update_background`: Set/clear user background image
 237
 238 ## `/api/v1/pleroma/accounts/confirmation_resend`
 239 ### Resend confirmation email
 240 * Method `POST`
 241 * Params:
 242     * `email`: email of that needs to be verified
 243 * Authentication: not required
 244 * Response: 204 No Content
 245
 246 ## `/api/v1/pleroma/mascot`
 247 ### Gets user mascot image
 248 * Method `GET`
 249 * Authentication: required
 250
 251 * Response: JSON. Returns a mastodon media attachment entity.
 252 * Example response:
 253 ```json
 254 {
 255     "id": "abcdefg",
 256     "url": "https://pleroma.example.org/media/abcdefg.png",
 257     "type": "image",
 258     "pleroma": {
 259         "mime_type": "image/png"
 260     }
 261 }
 262 ```
 263
 264 ### Updates user mascot image
 265 * Method `PUT`
 266 * Authentication: required
 267 * Params:
 268     * `file`: Multipart image
 269 * Response: JSON. Returns a mastodon media attachment entity
 270   when successful, otherwise returns HTTP 415 `{"error": "error_msg"}`
 271 * Example response:
 272 ```json
 273 {
 274     "id": "abcdefg",
 275     "url": "https://pleroma.example.org/media/abcdefg.png",
 276     "type": "image",
 277     "pleroma": {
 278         "mime_type": "image/png"
 279     }
 280 }
 281 ```
 282 * Note: Behaves exactly the same as `POST /api/v1/upload`.
 283   Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`.
 284
 285 ## `/api/pleroma/notification_settings`
 286 ### Updates user notification settings
 287 * Method `PUT`
 288 * Authentication: required
 289 * Params:
 290     * `from_followers`: BOOLEAN field, receives notifications from followers
 291     * `from_following`: BOOLEAN field, receives notifications from people the user follows
 292     * `from_strangers`: BOOLEAN field, receives notifications from people without an established relationship
 293     * `privacy_option`: BOOLEAN field. When set to true, it removes the contents of a message from the push notification.
 294 * Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}`
 295
 296 ## `/api/pleroma/healthcheck`
 297 ### Healthcheck endpoint with additional system data.
 298 * Method `GET`
 299 * Authentication: not required
 300 * Params: none
 301 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
 302 * Example response:
 303 ```json
 304 {
 305   "pool_size": 0, # database connection pool
 306   "active": 0, # active processes
 307   "idle": 0, # idle processes
 308   "memory_used": 0.00, # Memory used
 309   "healthy": true, # Instance state
 310   "job_queue_stats": {} # Job queue stats
 311 }
 312 ```
 313
 314 ## `/api/pleroma/change_email`
 315 ### Change account email
 316 * Method `POST`
 317 * Authentication: required
 318 * Params:
 319     * `password`: user's password
 320     * `email`: new email
 321 * Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
 322 * Note: Currently, Mastodon has no API for changing email. If they add it in future it might be incompatible with Pleroma.
 323
 324 # Pleroma Conversations
 325
 326 Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
 327
 328 1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
 329 2. Pleroma Conversations statuses can be requested by Conversation id.
 330 3. Pleroma Conversations can be replied to.
 331
 332 Conversations have the additional field `recipients` under the `pleroma` key. This holds a list of all the accounts that will receive a message in this conversation.
 333
 334 The status posting endpoint takes an additional parameter, `in_reply_to_conversation_id`, which, when set, will set the visiblity to direct and address only the people who are the recipients of that Conversation.
 335
 336 ⚠ Conversation IDs can be found in direct messages with the `pleroma.direct_conversation_id` key, do not confuse it with `pleroma.conversation_id`.
 337
 338 ## `GET /api/v1/pleroma/conversations/:id/statuses`
 339 ### Timeline for a given conversation
 340 * Method `GET`
 341 * Authentication: required
 342 * Params: Like other timelines
 343 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
 344
 345 ## `GET /api/v1/pleroma/conversations/:id`
 346 ### The conversation with the given ID.
 347 * Method `GET`
 348 * Authentication: required
 349 * Params: None
 350 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
 351
 352 ## `PATCH /api/v1/pleroma/conversations/:id`
 353 ### Update a conversation. Used to change the set of recipients.
 354 * Method `PATCH`
 355 * Authentication: required
 356 * Params:
 357     * `recipients`: A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though.
 358 * Response: JSON, statuses (200 - healthy, 503 unhealthy)
 359
 360 ## `POST /api/v1/pleroma/conversations/read`
 361 ### Marks all user's conversations as read.
 362 * Method `POST`
 363 * Authentication: required
 364 * Params: None
 365 * Response: JSON, returns a list of Mastodon Conversation entities that were marked as read (200 - healthy, 503 unhealthy).
 366
 367 ## `GET /api/pleroma/emoji/packs/import`
 368 ### Imports packs from filesystem
 369 * Method `GET`
 370 * Authentication: required
 371 * Params: None
 372 * Response: JSON, returns a list of imported packs.
 373
 374 ## `GET /api/pleroma/emoji/packs/remote`
 375 ### Make request to another instance for packs list
 376 * Method `GET`
 377 * Authentication: required
 378 * Params:
 379   * `url`: url of the instance to get packs from
 380 * Response: JSON with the pack list, hashmap with pack name and pack contents
 381
 382 ## `POST /api/pleroma/emoji/packs/download`
 383 ### Download pack from another instance
 384 * Method `POST`
 385 * Authentication: required
 386 * Params:
 387   * `url`: url of the instance to download from
 388   * `name`: pack to download from that instance
 389   * `as`: (*optional*) name how to save pack
 390 * Response: JSON, "ok" with 200 status if the pack was downloaded, or 500 if there were
 391   errors downloading the pack
 392
 393 ## `POST /api/pleroma/emoji/packs/:name`
 394 ### Creates an empty pack
 395 * Method `POST`
 396 * Authentication: required
 397 * Params: None
 398 * Response: JSON, "ok" and 200 status or 409 if the pack with that name already exists
 399
 400 ## `PATCH /api/pleroma/emoji/packs/:name`
 401 ### Updates (replaces) pack metadata
 402 * Method `PATCH`
 403 * Authentication: required
 404 * Params:
 405   * `metadata`: metadata to replace the old one
 406     * `license`: Pack license
 407     * `homepage`: Pack home page url
 408     * `description`: Pack description
 409     * `fallback-src`: Fallback url to download pack from
 410     * `fallback-src-sha256`: SHA256 encoded for fallback pack archive
 411     * `share-files`: is pack allowed for sharing (boolean)
 412 * Response: JSON, updated "metadata" section of the pack and 200 status or 400 if there was a
 413   problem with the new metadata (the error is specified in the "error" part of the response JSON)
 414
 415 ## `DELETE /api/pleroma/emoji/packs/:name`
 416 ### Delete a custom emoji pack
 417 * Method `DELETE`
 418 * Authentication: required
 419 * Params: None
 420 * Response: JSON, "ok" and 200 status or 500 if there was an error deleting the pack
 421
 422 ## `POST /api/pleroma/emoji/packs/:name/files`
 423 ### Add new file to the pack
 424 * Method `POST`
 425 * Authentication: required
 426 * Params:
 427   * `file`: file needs to be uploaded with the multipart request or link to remote file.
 428   * `shortcode`: (*optional*) shortcode for new emoji, must be unique for all emoji. If not sended, shortcode will be taken from original filename.
 429   * `filename`: (*optional*) new emoji file name. If not specified will be taken from original filename.
 430 * Response: JSON, list of files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
 431
 432 ## `PATCH /api/pleroma/emoji/packs/:name/files`
 433 ### Update emoji file from pack
 434 * Method `PATCH`
 435 * Authentication: required
 436 * Params:
 437   * `shortcode`: emoji file shortcode
 438   * `new_shortcode`: new emoji file shortcode
 439   * `new_filename`: new filename for emoji file
 440   * `force`: (*optional*) with true value to overwrite existing emoji with new shortcode
 441 * Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
 442
 443 ## `DELETE /api/pleroma/emoji/packs/:name/files`
 444 ### Delete emoji file from pack
 445 * Method `DELETE`
 446 * Authentication: required
 447 * Params:
 448   * `shortcode`: emoji file shortcode
 449 * Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
 450
 451 ## `GET /api/pleroma/emoji/packs`
 452 ### Lists local custom emoji packs
 453 * Method `GET`
 454 * Authentication: not required
 455 * Params: None
 456 * Response: JSON, "ok" and 200 status and the JSON hashmap of pack name to pack contents
 457
 458 ## `GET /api/pleroma/emoji/packs/:name`
 459 ### Get pack.json for the pack
 460 * Method `GET`
 461 * Authentication: not required
 462 * Params: None
 463 * Response: JSON, pack json with `files` and `pack` keys with 200 status or 404 if the pack does not exist
 464
 465 ## `GET /api/pleroma/emoji/packs/:name/archive`
 466 ### Requests a local pack archive from the instance
 467 * Method `GET`
 468 * Authentication: not required
 469 * Params: None
 470 * Response: the archive of the pack with a 200 status code, 403 if the pack is not set as shared,
 471   404 if the pack does not exist
 472
 473 ## `GET /api/v1/pleroma/accounts/:id/scrobbles`
 474 ### Requests a list of current and recent Listen activities for an account
 475 * Method `GET`
 476 * Authentication: not required
 477 * Params: None
 478 * Response: An array of media metadata entities.
 479 * Example response:
 480 ```json
 481 [
 482    {
 483        "account": {...},
 484        "id": "1234",
 485        "title": "Some Title",
 486        "artist": "Some Artist",
 487        "album": "Some Album",
 488        "length": 180000,
 489        "created_at": "2019-09-28T12:40:45.000Z"
 490    }
 491 ]
 492 ```
 493
 494 ## `POST /api/v1/pleroma/scrobble`
 495 ### Creates a new Listen activity for an account
 496 * Method `POST`
 497 * Authentication: required
 498 * Params:
 499   * `title`: the title of the media playing
 500   * `album`: the album of the media playing [optional]
 501   * `artist`: the artist of the media playing [optional]
 502   * `length`: the length of the media playing [optional]
 503 * Response: the newly created media metadata entity representing the Listen activity
 504
 505 # Emoji Reactions
 506
 507 Emoji reactions work a lot like favourites do. They make it possible to react to a post with a single emoji character. To detect the presence of this feature, you can check `pleroma_emoji_reactions` entry in the features list of nodeinfo.
 508
 509 ## `PUT /api/v1/pleroma/statuses/:id/reactions/:emoji`
 510 ### React to a post with a unicode emoji
 511 * Method: `PUT`
 512 * Authentication: required
 513 * Params: `emoji`: A single character unicode emoji
 514 * Response: JSON, the status.
 515
 516 ## `DELETE /api/v1/pleroma/statuses/:id/reactions/:emoji`
 517 ### Remove a reaction to a post with a unicode emoji
 518 * Method: `DELETE`
 519 * Authentication: required
 520 * Params: `emoji`: A single character unicode emoji
 521 * Response: JSON, the status.
 522
 523 ## `GET /api/v1/pleroma/statuses/:id/reactions`
 524 ### Get an object of emoji to account mappings with accounts that reacted to the post
 525 * Method: `GET`
 526 * Authentication: optional
 527 * Params: None
 528 * Response: JSON, a list of emoji/account list tuples, sorted by emoji insertion date, in ascending order, e.g, the first emoji in the list is the oldest.
 529 * Example Response:
 530 ```json
 531 [
 532   {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]},
 533   {"name": "☕", "count": 1, "me": false, "accounts": [{"id" => "abc..."}]}
 534 ]
 535 ```
 536
 537 ## `GET /api/v1/pleroma/statuses/:id/reactions/:emoji`
 538 ### Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji
 539 * Method: `GET`
 540 * Authentication: optional
 541 * Params: None
 542 * Response: JSON, a list of emoji/account list tuples
 543 * Example Response:
 544 ```json
 545 [
 546   {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]}
 547 ]
 548 ```