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