649 lines
16 KiB
Markdown
649 lines
16 KiB
Markdown
# 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
|
||
},
|
||
...
|
||
]
|
||
}
|
||
```
|
||
|
||
## `/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`
|
||
|
||
### Retrive the details of a user
|
||
|
||
- Method: `GET`
|
||
- Params:
|
||
- `nickname`
|
||
- 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
|
||
},
|
||
"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
|
||
},
|
||
"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,
|
||
"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 or boolean value can be passed with `:` in the beginning, e.g. `":true"`, `":upload"`. For keys it is not needed.
|
||
Integer with `i:`, e.g. `"i:150"`.
|
||
Tuple with more than 2 values with `{"tuple": ["first_val", Pleroma.Module, []]}`.
|
||
`{"tuple": ["some_string", "Pleroma.Some.Module", []]}` will be converted to `{"some_string", Pleroma.Some.Module, []}`.
|
||
|
||
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)
|
||
- `value` (string, [], {} or {"tuple": []})
|
||
- `delete` = true (optional, if parameter must be deleted)
|
||
]
|
||
|
||
- Request (example):
|
||
|
||
```json
|
||
{
|
||
configs: [
|
||
{
|
||
"group": "pleroma",
|
||
"key": "Pleroma.Upload",
|
||
"value": {
|
||
"uploader": "Pleroma.Uploaders.Local",
|
||
"filters": ["Pleroma.Upload.Filter.Dedupe"],
|
||
"link_name": ":true",
|
||
"proxy_remote": ":false",
|
||
"proxy_opts": {
|
||
"redirect_on_failure": ":false",
|
||
"max_body_length": "i:1048576",
|
||
"http": {
|
||
"follow_redirect": ":true",
|
||
"pool": ":upload"
|
||
}
|
||
},
|
||
"dispatch": {
|
||
"tuple": ["/api/v1/streaming", "Pleroma.Web.MastodonAPI.WebsocketHandler", []]
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
|
||
- Response:
|
||
|
||
```json
|
||
{
|
||
configs: [
|
||
{
|
||
"group": string,
|
||
"key": string,
|
||
"value": string or {} or [] or {"tuple": []}
|
||
}
|
||
]
|
||
}
|
||
```
|