pleroma/docs/Pleroma-API.md
Haelwenn (lanodan) Monnier 6adea5a7b2
Move to docs
2018-12-18 17:16:26 +01:00

1.2 KiB

Authentication

Requests that require it can be authenticated with an OAuth token, the _pleroma_key cookie, or HTTP Basic Authentication.

Request parameters

Request parameters can be passed via query strings or as form data. Files must be uploaded as multipart/form-data.

Endpoints

/api/pleroma/emoji

Lists the custom emoji on that server.

  • Method: GET
  • Authentication: not required
  • Params: none
  • Response: JSON
  • 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"}

/api/pleroma/follow_import

Imports your follows, for example from a Mastodon CSV file.

  • Method: POST
  • Authentication: required
  • Params:
    • list: STRING or FILE containing a whitespace-separated list of accounts to follow
    • Response: HTTP 200 on success, 500 on error
    • Note: Users that can't be followed are silently skipped.