diff options
| author | Alex Gleason <alex@alexgleason.me> | 2020-12-30 17:10:02 -0600 |
|---|---|---|
| committer | Alex Gleason <alex@alexgleason.me> | 2020-12-30 17:10:02 -0600 |
| commit | cbce88007672dc810cb345bb9872a009cbdc93d8 (patch) | |
| tree | 45be2517812f2a598d9b6133554038a87d4b9f46 /docs/API/pleroma_api.md | |
| parent | 83770b7b391fdf8bdc22f63047b1cf444a7b16ce (diff) | |
| parent | 38924166eb3228deb71a2e23f1e8fd3255c6bd85 (diff) | |
| download | pleroma-cbce88007672dc810cb345bb9872a009cbdc93d8.tar.gz pleroma-cbce88007672dc810cb345bb9872a009cbdc93d8.zip | |
Merge remote-tracking branch 'upstream/develop' into aliases
Diffstat (limited to 'docs/API/pleroma_api.md')
| -rw-r--r-- | docs/API/pleroma_api.md | 42 |
1 files changed, 40 insertions, 2 deletions
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md index 3fd141bd2..d8790ca32 100644 --- a/docs/API/pleroma_api.md +++ b/docs/API/pleroma_api.md @@ -579,14 +579,14 @@ Emoji reactions work a lot like favourites do. They make it possible to react to ### React to a post with a unicode emoji * Method: `PUT` * Authentication: required -* Params: `emoji`: A single character unicode emoji +* Params: `emoji`: A unicode RGI emoji or a regional indicator * Response: JSON, the status. ## `DELETE /api/v1/pleroma/statuses/:id/reactions/:emoji` ### Remove a reaction to a post with a unicode emoji * Method: `DELETE` * Authentication: required -* Params: `emoji`: A single character unicode emoji +* Params: `emoji`: A unicode RGI emoji or a regional indicator * Response: JSON, the status. ## `GET /api/v1/pleroma/statuses/:id/reactions` @@ -615,3 +615,41 @@ Emoji reactions work a lot like favourites do. They make it possible to react to {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]} ] ``` + +## `POST /api/v1/pleroma/backups` +### Create a user backup archive + +* Method: `POST` +* Authentication: required +* Params: none +* Response: JSON +* Example response: + +```json +[{ + "content_type": "application/zip", + "file_size": 0, + "inserted_at": "2020-09-10T16:18:03.000Z", + "processed": false, + "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip" +}] +``` + +## `GET /api/v1/pleroma/backups` +### Lists user backups + +* Method: `GET` +* Authentication: not required +* Params: none +* Response: JSON +* Example response: + +```json +[{ + "content_type": "application/zip", + "file_size": 55457, + "inserted_at": "2020-09-10T16:18:03.000Z", + "processed": true, + "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip" +}] +``` |