Requests that require it can be authenticated with an OAuth token, the _pleroma_key
cookie, or HTTP Basic Authentication.
Request parameters can be passed via query strings or as form data. Files must be uploaded as multipart/form-data
.
/api/pleroma/emoji
GET
{"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/v1/custom_emojis
but in a different format/api/pleroma/follow_import
POST
list
: STRING or FILE containing a whitespace-separated list of accounts to follow/api/pleroma/captcha
GET
type
{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}
/api/pleroma/delete_account
POST
password
: user's password{"status": "success"}
if the deletion was successful, {"error": "[error message]"}
otherwise{"error": "Invalid password."}
/api/account/register
POST
nickname
fullname
bio
email
password
confirm
captcha_solution
: optional, contains provider-specific captcha solution,captcha_token
: optional, contains provider-specific captcha tokentoken
: invite token required when the registerations aren't public.{"error": "error_msg"}
{
"background_image": null,
"cover_photo": "https://pleroma.soykaf.com/images/banner.png",
"created_at": "Tue Dec 18 16:55:56 +0000 2018",
"default_scope": "public",
"description": "blushy-crushy fediverse idol + pleroma dev\nlet's be friends \nぷれろまの生徒会長。謎の外人。日本語OK. \n公主病.",
"description_html": "blushy-crushy fediverse idol + pleroma dev.<br />let's be friends <br />ぷれろまの生徒会長。謎の外人。日本語OK. <br />公主病.",
"favourites_count": 0,
"fields": [],
"followers_count": 0,
"following": false,
"follows_you": false,
"friends_count": 0,
"id": 6,
"is_local": true,
"locked": false,
"name": "lain",
"name_html": "lain",
"no_rich_text": false,
"pleroma": {
"tags": []
},
"profile_image_url": "https://pleroma.soykaf.com/images/avi.png",
"profile_image_url_https": "https://pleroma.soykaf.com/images/avi.png",
"profile_image_url_original": "https://pleroma.soykaf.com/images/avi.png",
"profile_image_url_profile_size": "https://pleroma.soykaf.com/images/avi.png",
"rights": {
"delete_others_notice": false
},
"screen_name": "lain",
"statuses_count": 0,
"statusnet_blocking": false,
"statusnet_profile_url": "https://pleroma.soykaf.com/users/lain"
}
/api/pleroma/admin/
…See Admin-API
/api/v1/pleroma/flavour/:flavour
POST
{"error": "error_msg"}
/api/v1/pleroma/flavour
GET