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

   1 # Authentication
   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
   6
   7 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`.
   8
   9 # Endpoints
  10
  11 ## `/api/pleroma/emoji`
  12 ### Lists the custom emoji on that server.
  13 * Method: `GET`
  14 * Authentication: not required
  15 * Params: none
  16 * Response: JSON
  17 * Example response: `{"kalsarikannit_f":"/finmoji/128px/kalsarikannit_f-128.png","perkele":"/finmoji/128px/perkele-128.png","blobdab":"/emoji/blobdab.png","happiness":"/finmoji/128px/happiness-128.png"}`
  18
  19 ## `/api/pleroma/follow_import`
  20 ### Imports your follows, for example from a Mastodon CSV file.
  21 * Method: `POST`
  22 * Authentication: required
  23 * Params:
  24     * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
  25     * Response: HTTP 200 on success, 500 on error
  26     * Note: Users that can't be followed are silently skipped.