Authentication is required and the user must be an admin.
/api/pleroma/admin/users
GET
query
: string search term (e.g. nickname, domain, nickname@domain)filters
: string comma-separated string of filters:
local
: only local usersexternal
: only external usersactive
: only active usersdeactivated
: only deactivated usersis_admin
: users with admin roleis_moderator
: users with moderator rolepage
: integer page numberpage_size
: integer number of users per page (default is 50
)tags
: [string] tags listname
: string user display nameemail
: string user emailhttps://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
{
"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
DELETE
nickname
POST
nickname
email
password
/api/pleroma/admin/users/follow
POST
follower
: The nickname of the followerfollowed
: The nickname of the followed/api/pleroma/admin/users/unfollow
POST
follower
: The nickname of the followerfollowed
: The nickname of the followed/api/pleroma/admin/users/:nickname/toggle_activation
PATCH
nickname
{
"deactivated": bool,
"id": integer,
"nickname": string
}
/api/pleroma/admin/users/tag
PUT
nicknames
(array)tags
(array)DELETE
nicknames
(array)tags
(array)/api/pleroma/admin/users/:nickname/permission_group
GET
{
"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
{
"is_moderator": bool,
"is_admin": bool
}
POST
{"error": "…"}
user.info
DELETE
{"error": "…"}
user.info
/api/pleroma/admin/users/:nickname/activation_status
PUT
nickname
status
BOOLEAN field, false value means deactivation./api/pleroma/admin/users/:nickname_or_id
GET
nickname
or id
Not found
/api/pleroma/admin/users/:nickname_or_id/statuses
GET
nickname
or id
page_size
: number of statuses to return (default is 20
)godmode
: true
/false
– allows to see private statusesNot found
/api/pleroma/admin/relay
POST
relay_url
DELETE
relay_url
/api/pleroma/admin/users/invite_token
GET
invite
=> [
max_use
(integer)expires_at
(date string e.g. “2019-04-07”)
]/api/pleroma/admin/users/invites
GET
{
"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
POST
token
{
"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
POST
email
name
, optional/api/pleroma/admin/users/:nickname/password_reset
GET
/api/pleroma/admin/reports
GET
state
: optional, the state of reports. Valid values are open
, closed
and resolved
limit
: optional, the number of records to retrievesince_id
: optional, returns results that are more recent than the specified idmax_id
: optional, returns results that are older than the specified id{"error": "error_msg"}
when requested by anonymous or non-adminaccount
: the user who has been reportedactor
: the user who has sent the reportstatuses
: list of statuses that have been included to the report{
"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
id
{"error": "error_msg"}
"Not found"
/api/pleroma/admin/reports/:id
PUT
id
state
: required, the new state. Valid values are open
, closed
and resolved
"Unsupported state"
{"error": "error_msg"}
"Not found"
/api/pleroma/admin/reports/:id/respond
POST
id
status
: required, the message"Invalid parameters"
when status
is missing{"error": "error_msg"}
"Not found"
{
"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
PUT
id
sensitive
: optional, valid values are true
or false
visibility
: optional, valid values are public
, private
and unlisted
"Unsupported visibility"
{"error": "error_msg"}
"Not found"
/api/pleroma/admin/statuses/:id
DELETE
id
{"error": "error_msg"}
"Not found"
{}
/api/pleroma/admin/config/migrate_to_db
Copy settings on key :pleroma
to DB.
GET
{}
/api/pleroma/admin/config/migrate_from_db
Copy all settings from DB to config/prod.exported_from_db.secret.exs
with deletion from DB.
GET
{}
/api/pleroma/admin/config
List config settings only works with :pleroma => :instance => :dynamic_configuration
setting to true
.
GET
{
configs: [
{
"group": string,
"key": string or string with leading `:` for atoms,
"value": string or {} or [] or {"tuple": []}
}
]
}
/api/pleroma/admin/config
Updating config settings only works with :pleroma => :instance => :dynamic_configuration
setting to true
.
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):
{
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": []}
}
]
}