aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/admin_api.md654
-rw-r--r--docs/api/differences_in_mastoapi_responses.md119
-rw-r--r--docs/api/pleroma_api.md313
-rw-r--r--docs/api/prometheus.md22
4 files changed, 0 insertions, 1108 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md
deleted file mode 100644
index c429da822..000000000
--- a/docs/api/admin_api.md
+++ /dev/null
@@ -1,654 +0,0 @@
-# Admin API
-
-Authentication is required and the user must be an admin.
-
-## `/api/pleroma/admin/users`
-
-### List users
-
-- Method `GET`
-- Query Params:
- - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)
- - *optional* `filters`: **string** comma-separated string of filters:
- - `local`: only local users
- - `external`: only external users
- - `active`: only active users
- - `deactivated`: only deactivated users
- - `is_admin`: users with admin role
- - `is_moderator`: users with moderator role
- - *optional* `page`: **integer** page number
- - *optional* `page_size`: **integer** number of users per page (default is `50`)
- - *optional* `tags`: **[string]** tags list
- - *optional* `name`: **string** user display name
- - *optional* `email`: **string** user email
-- Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10&tags[]=some_tag&tags[]=another_tag&name=display_name&email=email@example.com`
-- Response:
-
-```json
-{
- "page_size": integer,
- "count": integer,
- "users": [
- {
- "deactivated": bool,
- "id": integer,
- "nickname": string,
- "roles": {
- "admin": bool,
- "moderator": bool
- },
- "local": bool,
- "tags": array,
- "avatar": string,
- "display_name": string
- },
- ...
- ]
-}
-```
-
-## `/api/pleroma/admin/users`
-
-### Remove a user
-
-- Method `DELETE`
-- Params:
- - `nickname`
-- Response: User’s nickname
-
-### Create a user
-
-- Method: `POST`
-- Params:
- - `nickname`
- - `email`
- - `password`
-- Response: User’s nickname
-
-## `/api/pleroma/admin/users/follow`
-### Make a user follow another user
-
-- Methods: `POST`
-- Params:
- - `follower`: The nickname of the follower
- - `followed`: The nickname of the followed
-- Response:
- - "ok"
-
-## `/api/pleroma/admin/users/unfollow`
-### Make a user unfollow another user
-
-- Methods: `POST`
-- Params:
- - `follower`: The nickname of the follower
- - `followed`: The nickname of the followed
-- Response:
- - "ok"
-
-## `/api/pleroma/admin/users/:nickname/toggle_activation`
-
-### Toggle user activation
-
-- Method: `PATCH`
-- Params:
- - `nickname`
-- Response: User’s object
-
-```json
-{
- "deactivated": bool,
- "id": integer,
- "nickname": string
-}
-```
-
-## `/api/pleroma/admin/users/tag`
-
-### Tag a list of users
-
-- Method: `PUT`
-- Params:
- - `nicknames` (array)
- - `tags` (array)
-
-### Untag a list of users
-
-- Method: `DELETE`
-- Params:
- - `nicknames` (array)
- - `tags` (array)
-
-## `/api/pleroma/admin/users/:nickname/permission_group`
-
-### Get user user permission groups membership
-
-- Method: `GET`
-- Params: none
-- Response:
-
-```json
-{
- "is_moderator": bool,
- "is_admin": bool
-}
-```
-
-## `/api/pleroma/admin/users/:nickname/permission_group/:permission_group`
-
-Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
-
-### Get user user permission groups membership per permission group
-
-- Method: `GET`
-- Params: none
-- Response:
-
-```json
-{
- "is_moderator": bool,
- "is_admin": bool
-}
-```
-
-### Add user in permission group
-
-- Method: `POST`
-- Params: none
-- Response:
- - On failure: `{"error": "…"}`
- - On success: JSON of the `user.info`
-
-### Remove user from permission group
-
-- Method: `DELETE`
-- Params: none
-- Response:
- - On failure: `{"error": "…"}`
- - On success: JSON of the `user.info`
-- Note: An admin cannot revoke their own admin status.
-
-## `/api/pleroma/admin/users/:nickname/activation_status`
-
-### Active or deactivate a user
-
-- Method: `PUT`
-- Params:
- - `nickname`
- - `status` BOOLEAN field, false value means deactivation.
-
-## `/api/pleroma/admin/users/:nickname_or_id`
-
-### Retrive the details of a user
-
-- Method: `GET`
-- Params:
- - `nickname` or `id`
-- Response:
- - On failure: `Not found`
- - On success: JSON of the user
-
-## `/api/pleroma/admin/relay`
-
-### Follow a Relay
-
-- Methods: `POST`
-- Params:
- - `relay_url`
-- Response:
- - On success: URL of the followed relay
-
-### Unfollow a Relay
-
-- Methods: `DELETE`
-- Params:
- - `relay_url`
-- Response:
- - On success: URL of the unfollowed relay
-
-## `/api/pleroma/admin/users/invite_token`
-
-### Get an account registration invite token
-
-- Methods: `GET`
-- Params:
- - *optional* `invite` => [
- - *optional* `max_use` (integer)
- - *optional* `expires_at` (date string e.g. "2019-04-07")
- ]
-- Response: invite token (base64 string)
-
-## `/api/pleroma/admin/users/invites`
-
-### Get a list of generated invites
-
-- Methods: `GET`
-- Params: none
-- Response:
-
-```json
-{
-
- "invites": [
- {
- "id": integer,
- "token": string,
- "used": boolean,
- "expires_at": date,
- "uses": integer,
- "max_use": integer,
- "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
- },
- ...
- ]
-}
-```
-
-## `/api/pleroma/admin/users/revoke_invite`
-
-### Revoke invite by token
-
-- Methods: `POST`
-- Params:
- - `token`
-- Response:
-
-```json
-{
- "id": integer,
- "token": string,
- "used": boolean,
- "expires_at": date,
- "uses": integer,
- "max_use": integer,
- "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
-
-}
-```
-
-
-## `/api/pleroma/admin/users/email_invite`
-
-### Sends registration invite via email
-
-- Methods: `POST`
-- Params:
- - `email`
- - `name`, optional
-
-## `/api/pleroma/admin/users/:nickname/password_reset`
-
-### Get a password reset token for a given nickname
-
-- Methods: `GET`
-- Params: none
-- Response: password reset token (base64 string)
-
-## `/api/pleroma/admin/reports`
-### Get a list of reports
-- Method `GET`
-- Params:
- - `state`: optional, the state of reports. Valid values are `open`, `closed` and `resolved`
- - `limit`: optional, the number of records to retrieve
- - `since_id`: optional, returns results that are more recent than the specified id
- - `max_id`: optional, returns results that are older than the specified id
-- Response:
- - On failure: 403 Forbidden error `{"error": "error_msg"}` when requested by anonymous or non-admin
- - On success: JSON, returns a list of reports, where:
- - `account`: the user who has been reported
- - `actor`: the user who has sent the report
- - `statuses`: list of statuses that have been included to the report
-
-```json
-{
- "reports": [
- {
- "account": {
- "acct": "user",
- "avatar": "https://pleroma.example.org/images/avi.png",
- "avatar_static": "https://pleroma.example.org/images/avi.png",
- "bot": false,
- "created_at": "2019-04-23T17:32:04.000Z",
- "display_name": "User",
- "emojis": [],
- "fields": [],
- "followers_count": 1,
- "following_count": 1,
- "header": "https://pleroma.example.org/images/banner.png",
- "header_static": "https://pleroma.example.org/images/banner.png",
- "id": "9i6dAJqSGSKMzLG2Lo",
- "locked": false,
- "note": "",
- "pleroma": {
- "confirmation_pending": false,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_follows": false,
- "is_admin": false,
- "is_moderator": false,
- "relationship": {},
- "tags": []
- },
- "source": {
- "note": "",
- "pleroma": {},
- "sensitive": false
- },
- "tags": ["force_unlisted"],
- "statuses_count": 3,
- "url": "https://pleroma.example.org/users/user",
- "username": "user"
- },
- "actor": {
- "acct": "lain",
- "avatar": "https://pleroma.example.org/images/avi.png",
- "avatar_static": "https://pleroma.example.org/images/avi.png",
- "bot": false,
- "created_at": "2019-03-28T17:36:03.000Z",
- "display_name": "Roger Braun",
- "emojis": [],
- "fields": [],
- "followers_count": 1,
- "following_count": 1,
- "header": "https://pleroma.example.org/images/banner.png",
- "header_static": "https://pleroma.example.org/images/banner.png",
- "id": "9hEkA5JsvAdlSrocam",
- "locked": false,
- "note": "",
- "pleroma": {
- "confirmation_pending": false,
- "hide_favorites": false,
- "hide_followers": false,
- "hide_follows": false,
- "is_admin": false,
- "is_moderator": false,
- "relationship": {},
- "tags": []
- },
- "source": {
- "note": "",
- "pleroma": {},
- "sensitive": false
- },
- "tags": ["force_unlisted"],
- "statuses_count": 1,
- "url": "https://pleroma.example.org/users/lain",
- "username": "lain"
- },
- "content": "Please delete it",
- "created_at": "2019-04-29T19:48:15.000Z",
- "id": "9iJGOv1j8hxuw19bcm",
- "state": "open",
- "statuses": [
- {
- "account": { ... },
- "application": {
- "name": "Web",
- "website": null
- },
- "bookmarked": false,
- "card": null,
- "content": "<span class=\"h-card\"><a data-user=\"9hEkA5JsvAdlSrocam\" class=\"u-url mention\" href=\"https://pleroma.example.org/users/lain\">@<span>lain</span></a></span> click on my link <a href=\"https://www.google.com/\">https://www.google.com/</a>",
- "created_at": "2019-04-23T19:15:47.000Z",
- "emojis": [],
- "favourited": false,
- "favourites_count": 0,
- "id": "9i6mQ9uVrrOmOime8m",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [],
- "mentions": [
- {
- "acct": "lain",
- "id": "9hEkA5JsvAdlSrocam",
- "url": "https://pleroma.example.org/users/lain",
- "username": "lain"
- },
- {
- "acct": "user",
- "id": "9i6dAJqSGSKMzLG2Lo",
- "url": "https://pleroma.example.org/users/user",
- "username": "user"
- }
- ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "@lain click on my link https://www.google.com/"
- },
- "conversation_id": 28,
- "in_reply_to_account_acct": null,
- "local": true,
- "spoiler_text": {
- "text/plain": ""
- }
- },
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [],
- "uri": "https://pleroma.example.org/objects/8717b90f-8e09-4b58-97b0-e3305472b396",
- "url": "https://pleroma.example.org/notice/9i6mQ9uVrrOmOime8m",
- "visibility": "direct"
- }
- ]
- }
- ]
-}
-```
-
-## `/api/pleroma/admin/reports/:id`
-### Get an individual report
-- Method `GET`
-- Params:
- - `id`
-- Response:
- - On failure:
- - 403 Forbidden `{"error": "error_msg"}`
- - 404 Not Found `"Not found"`
- - On success: JSON, Report object (see above)
-
-## `/api/pleroma/admin/reports/:id`
-### Change the state of the report
-- Method `PUT`
-- Params:
- - `id`
- - `state`: required, the new state. Valid values are `open`, `closed` and `resolved`
-- Response:
- - On failure:
- - 400 Bad Request `"Unsupported state"`
- - 403 Forbidden `{"error": "error_msg"}`
- - 404 Not Found `"Not found"`
- - On success: JSON, Report object (see above)
-
-## `/api/pleroma/admin/reports/:id/respond`
-### Respond to a report
-- Method `POST`
-- Params:
- - `id`
- - `status`: required, the message
-- Response:
- - On failure:
- - 400 Bad Request `"Invalid parameters"` when `status` is missing
- - 403 Forbidden `{"error": "error_msg"}`
- - 404 Not Found `"Not found"`
- - On success: JSON, created Mastodon Status entity
-
-```json
-{
- "account": { ... },
- "application": {
- "name": "Web",
- "website": null
- },
- "bookmarked": false,
- "card": null,
- "content": "Your claim is going to be closed",
- "created_at": "2019-05-11T17:13:03.000Z",
- "emojis": [],
- "favourited": false,
- "favourites_count": 0,
- "id": "9ihuiSL1405I65TmEq",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [],
- "mentions": [
- {
- "acct": "user",
- "id": "9i6dAJqSGSKMzLG2Lo",
- "url": "https://pleroma.example.org/users/user",
- "username": "user"
- },
- {
- "acct": "admin",
- "id": "9hEkA5JsvAdlSrocam",
- "url": "https://pleroma.example.org/users/admin",
- "username": "admin"
- }
- ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "Your claim is going to be closed"
- },
- "conversation_id": 35,
- "in_reply_to_account_acct": null,
- "local": true,
- "spoiler_text": {
- "text/plain": ""
- }
- },
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [],
- "uri": "https://pleroma.example.org/objects/cab0836d-9814-46cd-a0ea-529da9db5fcb",
- "url": "https://pleroma.example.org/notice/9ihuiSL1405I65TmEq",
- "visibility": "direct"
-}
-```
-
-## `/api/pleroma/admin/statuses/:id`
-### Change the scope of an individual reported status
-- Method `PUT`
-- Params:
- - `id`
- - `sensitive`: optional, valid values are `true` or `false`
- - `visibility`: optional, valid values are `public`, `private` and `unlisted`
-- Response:
- - On failure:
- - 400 Bad Request `"Unsupported visibility"`
- - 403 Forbidden `{"error": "error_msg"}`
- - 404 Not Found `"Not found"`
- - On success: JSON, Mastodon Status entity
-
-## `/api/pleroma/admin/statuses/:id`
-### Delete an individual reported status
-- Method `DELETE`
-- Params:
- - `id`
-- Response:
- - On failure:
- - 403 Forbidden `{"error": "error_msg"}`
- - 404 Not Found `"Not found"`
- - On success: 200 OK `{}`
-
-## `/api/pleroma/admin/config`
-### List config settings
-- Method `GET`
-- Params: none
-- Response:
-
-```json
-{
- configs: [
- {
- "group": string,
- "key": string or string with leading `:` for atoms,
- "value": string or {} or [] or {"tuple": []}
- }
- ]
-}
-```
-
-## `/api/pleroma/admin/config`
-### Update config settings
-Module name can be passed as string, which starts with `Pleroma`, e.g. `"Pleroma.Upload"`.
-Atom keys and values can be passed with `:` in the beginning, e.g. `":upload"`.
-Tuples can be passed as `{"tuple": ["first_val", Pleroma.Module, []]}`.
-`{"tuple": ["some_string", "Pleroma.Some.Module", []]}` will be converted to `{"some_string", Pleroma.Some.Module, []}`.
-Keywords can be passed as lists with 2 child tuples, e.g.
-`[{"tuple": ["first_val", Pleroma.Module]}, {"tuple": ["second_val", true]}]`.
-
-Compile time settings (need instance reboot):
-- all settings by this keys:
- - `:hackney_pools`
- - `:chat`
- - `Pleroma.Web.Endpoint`
- - `Pleroma.Repo`
-- part settings:
- - `Pleroma.Captcha` -> `:seconds_valid`
- - `Pleroma.Upload` -> `:proxy_remote`
- - `:instance` -> `:upload_limit`
-
-- Method `POST`
-- Params:
- - `configs` => [
- - `group` (string)
- - `key` (string or string with leading `:` for atoms)
- - `value` (string, [], {} or {"tuple": []})
- - `delete` = true (optional, if parameter must be deleted)
- ]
-
-- Request (example):
-
-```json
-{
- configs: [
- {
- "group": "pleroma",
- "key": "Pleroma.Upload",
- "value": [
- {"tuple": [":uploader", "Pleroma.Uploaders.Local"]},
- {"tuple": [":filters", ["Pleroma.Upload.Filter.Dedupe"]]},
- {"tuple": [":link_name", true]},
- {"tuple": [":proxy_remote", false]},
- {"tuple": [":proxy_opts", [
- {"tuple": [":redirect_on_failure", false]},
- {"tuple": [":max_body_length", 1048576]},
- {"tuple": [":http": [
- {"tuple": [":follow_redirect", true]},
- {"tuple": [":pool", ":upload"]},
- ]]}
- ]
- ]},
- {"tuple": [":dispatch", {
- "tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
- }]}
- ]
- }
- ]
-}
-
-- Response:
-
-```json
-{
- configs: [
- {
- "group": string,
- "key": string or string with leading `:` for atoms,
- "value": string or {} or [] or {"tuple": []}
- }
- ]
-}
-```
diff --git a/docs/api/differences_in_mastoapi_responses.md b/docs/api/differences_in_mastoapi_responses.md
deleted file mode 100644
index 1907d70c8..000000000
--- a/docs/api/differences_in_mastoapi_responses.md
+++ /dev/null
@@ -1,119 +0,0 @@
-# Differences in Mastodon API responses from vanilla Mastodon
-
-A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
-
-## Flake IDs
-
-Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However just like Mastodon's ids they are sortable strings
-
-## Attachment cap
-
-Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
-
-## Timelines
-
-Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
-
-## Statuses
-
-- `visibility`: has an additional possible value `list`
-
-Has these additional fields under the `pleroma` object:
-
-- `local`: true if the post was made on the local instance
-- `conversation_id`: the ID of the conversation the status is associated with (if any)
-- `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
-- `content`: a map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
-- `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
-
-## Attachments
-
-Has these additional fields under the `pleroma` object:
-
-- `mime_type`: mime type of the attachment.
-
-## Accounts
-
-The `id` parameter can also be the `nickname` of the user. This only works in these endpoints, not the deeper nested ones for following etc.
-
-- `/api/v1/accounts/:id`
-- `/api/v1/accounts/:id/statuses`
-
-Has these additional fields under the `pleroma` object:
-
-- `tags`: Lists an array of tags for the user
-- `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/api/entities/#relationship
-- `is_moderator`: boolean, nullable, true if user is a moderator
-- `is_admin`: boolean, nullable, true if user is an admin
-- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
-- `hide_followers`: boolean, true when the user has follower hiding enabled
-- `hide_follows`: boolean, true when the user has follow hiding enabled
-- `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `verify_credentials` and `update_credentials`
-- `chat_token`: The token needed for Pleroma chat. Only returned in `verify_credentials`
-- `deactivated`: boolean, true when the user is deactivated
-
-### Source
-
-Has these additional fields under the `pleroma` object:
-
-- `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
-- `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
-
-## Account Search
-
-Behavior has changed:
-
-- `/api/v1/accounts/search`: Does not require authentication
-
-## Notifications
-
-Has these additional fields under the `pleroma` object:
-
-- `is_seen`: true if the notification was read by the user
-
-## POST `/api/v1/statuses`
-
-Additional parameters can be added to the JSON body/Form data:
-
-- `preview`: boolean, if set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
-- `content_type`: string, contain the MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint.
-- `to`: A list of nicknames (like `lain@soykaf.club` or `lain` on the local server) that will be used to determine who is going to be addressed by this post. Using this will disable the implicit addressing by mentioned names in the `status` body, only the people in the `to` list will be addressed. The normal rules for for post visibility are not affected by this and will still apply.
-- `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
-
-## PATCH `/api/v1/update_credentials`
-
-Additional parameters can be added to the JSON body/Form data:
-
-- `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
-- `hide_followers` - if true, user's followers will be hidden
-- `hide_follows` - if true, user's follows will be hidden
-- `hide_favorites` - if true, user's favorites timeline will be hidden
-- `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
-- `default_scope` - the scope returned under `privacy` key in Source subentity
-- `pleroma_settings_store` - Opaque user settings to be saved on the backend.
-- `skip_thread_containment` - if true, skip filtering out broken threads
-- `pleroma_background_image` - sets the background image of the user.
-
-### Pleroma Settings Store
-Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.
-
-The parameter should have a form of `{frontend_name: {...}}`, with `frontend_name` identifying your type of client, e.g. `pleroma_fe`. It will overwrite everything under this property, but will not overwrite other frontend's settings.
-
-This information is returned in the `verify_credentials` endpoint.
-
-## Authentication
-
-*Pleroma supports refreshing tokens.
-
-`POST /oauth/token`
-Post here request with grant_type=refresh_token to obtain new access token. Returns an access token.
-
-## Account Registration
-`POST /api/v1/accounts`
-
-Has theses additionnal parameters (which are the same as in Pleroma-API):
- * `fullname`: optional
- * `bio`: optional
- * `captcha_solution`: optional, contains provider-specific captcha solution,
- * `captcha_token`: optional, contains provider-specific captcha token
- * `token`: invite token required when the registerations aren't public.
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
deleted file mode 100644
index d83ebd734..000000000
--- a/docs/api/pleroma_api.md
+++ /dev/null
@@ -1,313 +0,0 @@
-# Pleroma API
-
-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).
-
-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`.
-
-## `/api/pleroma/emoji`
-### Lists the custom emoji on that server.
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-* Example response:
-```json
-{
- "girlpower": {
- "tags": [
- "Finmoji"
- ],
- "image_url": "/finmoji/128px/girlpower-128.png"
- },
- "education": {
- "tags": [
- "Finmoji"
- ],
- "image_url": "/finmoji/128px/education-128.png"
- },
- "finnishlove": {
- "tags": [
- "Finmoji"
- ],
- "image_url": "/finmoji/128px/finnishlove-128.png"
- }
-}
-```
-* Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format
-
-## `/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.
-
-## `/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/pleroma/disable_account`
-### Disable an account
-* Method `POST`
-* Authentication: required
-* Params:
- * `password`: user's password
-* Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"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
- * `token`: invite token required when the registrations aren't public.
-* Response: JSON. Returns a user object on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-{
- "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](Admin-API.md)
-
-## `/api/pleroma/notifications/read`
-### Mark a single notification as read
-* Method `POST`
-* Authentication: required
-* Params:
- * `id`: notification's id
-* Response: JSON. Returns `{"status": "success"}` if the reading was successful, otherwise returns `{"error": "error_msg"}`
-
-## `/api/v1/pleroma/accounts/:id/subscribe`
-### Subscribe to receive notifications for all statuses posted by a user
-* Method `POST`
-* Authentication: required
-* Params:
- * `id`: account id to subscribe to
-* Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-{
- "id": "abcdefg",
- "following": true,
- "followed_by": false,
- "blocking": false,
- "muting": false,
- "muting_notifications": false,
- "subscribing": true,
- "requested": false,
- "domain_blocking": false,
- "showing_reblogs": true,
- "endorsed": false
-}
-```
-
-## `/api/v1/pleroma/accounts/:id/unsubscribe`
-### Unsubscribe to stop receiving notifications from user statuses
-* Method `POST`
-* Authentication: required
-* Params:
- * `id`: account id to unsubscribe from
-* Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-{
- "id": "abcdefg",
- "following": true,
- "followed_by": false,
- "blocking": false,
- "muting": false,
- "muting_notifications": false,
- "subscribing": false,
- "requested": false,
- "domain_blocking": false,
- "showing_reblogs": true,
- "endorsed": false
-}
-```
-
-## `/api/v1/pleroma/accounts/:id/favourites`
-### Returns favorites timeline of any user
-* Method `GET`
-* Authentication: not required
-* Params:
- * `id`: the id of the account for whom to return results
- * `limit`: optional, the number of records to retrieve
- * `since_id`: optional, returns results that are more recent than the specified id
- * `max_id`: optional, returns results that are older than the specified id
-* Response: JSON, returns a list of Mastodon Status entities on success, otherwise returns `{"error": "error_msg"}`
-* Example response:
-```json
-[
- {
- "account": {
- "id": "9hptFmUF3ztxYh3Svg",
- "url": "https://pleroma.example.org/users/nick2",
- "username": "nick2",
- ...
- },
- "application": {"name": "Web", "website": null},
- "bookmarked": false,
- "card": null,
- "content": "This is :moominmamma: note 0",
- "created_at": "2019-04-15T15:42:15.000Z",
- "emojis": [],
- "favourited": false,
- "favourites_count": 1,
- "id": "9hptFmVJ02khbzYJaS",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [],
- "mentions": [],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {"text/plain": "This is :moominmamma: note 0"},
- "conversation_id": 13679,
- "local": true,
- "spoiler_text": {"text/plain": "2hu"}
- },
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "2hu",
- "tags": [{"name": "2hu", "url": "/tag/2hu"}],
- "uri": "https://pleroma.example.org/objects/198ed2a1-7912-4482-b559-244a0369e984",
- "url": "https://pleroma.example.org/notice/9hptFmVJ02khbzYJaS",
- "visibility": "public"
- }
-]
-```
-
-## `/api/v1/pleroma/accounts/update_*`
-### Set and clear account avatar, banner, and background
-
-- PATCH `/api/v1/pleroma/accounts/update_avatar`: Set/clear user avatar image
-- PATCH `/api/v1/pleroma/accounts/update_banner`: Set/clear user banner image
-- PATCH `/api/v1/pleroma/accounts/update_background`: Set/clear user background image
-
-## `/api/v1/pleroma/mascot`
-### Gets user mascot image
-* Method `GET`
-* Authentication: required
-
-* Response: JSON. Returns a mastodon media attachment entity.
-* Example response:
-```json
-{
- "id": "abcdefg",
- "url": "https://pleroma.example.org/media/abcdefg.png",
- "type": "image",
- "pleroma": {
- "mime_type": "image/png"
- }
-}
-```
-
-### Updates user mascot image
-* Method `PUT`
-* Authentication: required
-* Params:
- * `image`: Multipart image
-* Response: JSON. Returns a mastodon media attachment entity
- when successful, otherwise returns HTTP 415 `{"error": "error_msg"}`
-* Example response:
-```json
-{
- "id": "abcdefg",
- "url": "https://pleroma.example.org/media/abcdefg.png",
- "type": "image",
- "pleroma": {
- "mime_type": "image/png"
- }
-}
-```
-* Note: Behaves exactly the same as `POST /api/v1/upload`.
- Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`.
-
-## `/api/pleroma/notification_settings`
-### Updates user notification settings
-* Method `PUT`
-* Authentication: required
-* Params:
- * `followers`: BOOLEAN field, receives notifications from followers
- * `follows`: BOOLEAN field, receives notifications from people the user follows
- * `remote`: BOOLEAN field, receives notifications from people on remote instances
- * `local`: BOOLEAN field, receives notifications from people on the local instance
-* Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}`
-
-## `/api/pleroma/healthcheck`
-### Healthcheck endpoint with additional system data.
-* Method `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON, statuses (200 - healthy, 503 unhealthy).
-* Example response:
-```json
-{
- "pool_size": 0, # database connection pool
- "active": 0, # active processes
- "idle": 0, # idle processes
- "memory_used": 0.00, # Memory used
- "healthy": true # Instance state
-}
-```
diff --git a/docs/api/prometheus.md b/docs/api/prometheus.md
deleted file mode 100644
index 19c564e3c..000000000
--- a/docs/api/prometheus.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# Prometheus Metrics
-
-Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library.
-
-## `/api/pleroma/app_metrics`
-### Exports Prometheus application metrics
-* Method: `GET`
-* Authentication: not required
-* Params: none
-* Response: JSON
-
-## Grafana
-### Config example
-The following is a config example to use with [Grafana](https://grafana.com)
-
-```
- - job_name: 'beam'
- metrics_path: /api/pleroma/app_metrics
- scheme: https
- static_configs:
- - targets: ['pleroma.soykaf.com']
-```
generated by cgit v1.2.3 (git 2.26.2) at 2025-04-25 18:12:17 +0000