Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
pleroma
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
normandy
pleroma
Commits
d6b133ec
Verified
Commit
d6b133ec
authored
6 years ago
by
rinpatch
Committed by
Haelwenn
6 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Pleroma-API.md: Additionnal endpoints
parent
6adea5a7
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/Pleroma-API.md
+71
-2
71 additions, 2 deletions
docs/Pleroma-API.md
with
71 additions
and
2 deletions
docs/Pleroma-API.md
+
71
−
2
View file @
d6b133ec
...
...
@@ -22,5 +22,74 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
*
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.
*
Response: HTTP 200 on success, 500 on error
*
Note: Users that can't be followed are silently skipped.
## `/api/pleroma/captcha`
### Get a new captcha
*
Method:
`GET`
*
Authentication: not required
*
Params: none
*
Response: Provider specific JSON, the only guaranteed parameter is
`type`
*
Example response:
`{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}`
## `/api/pleroma/delete_account`
### Delete an account
*
Method
`POST`
*
Authentication: required
*
Params:
*
`password`
: user's password
*
Response: JSON. Returns
`{"status": "success"}`
if the deletion was successful,
`{"error": "[error message]"}`
otherwise
*
Example response:
`{"error": "Invalid password."}`
## `/api/account/register`
### Register a new user
*
Method
`POST`
*
Authentication: not required
*
Params:
*
`nickname`
*
`fullname`
*
`bio`
*
`email`
*
`password`
*
`confirm`
*
`captcha_solution`
: optional, contains provider-specific captcha solution,
*
`captcha_token`
: optional, contains provider-specific captcha token
*
Response: JSON. Returns a user object on success, otherwise returns
`{"error": "error_msg"}`
*
Example response:
```
{
"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"
}
```
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment