documentation/admin.md at 8fe194b433fd0972e6859243ef25f726d5f7fc48

mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

* add identifier for troubleshooting pages

* mention mutes can be temporary now

* bell for notifications

* convert images to jpg and rename them

* suspensions now reversible

* unread notifications

* suspended: true

* mutes expiry

* replies_policy, type of notification

* notify

* featuredTags AP representation

* new env vars

* accounts merge

* maintenance cli

* list replies

* suspended flag

* follower sync

* minor formatting

* add note about idempotency of follow action

* account featured tags, min_id and max_id, plus normalization

* follow marcin and nightpool's suggestion

* bearcaps

* replies_policy update

* featuredtags now have a url

2020-12-27 07:03:55 +01:00

19 KiB

Raw Blame History

title

description

admin

Perform moderation actions with accounts and reports.

docs

weight	parent	identifier
80	methods	methods-admin

Responses are not currently documented. Exact nature of parameters has not been validated. {{< /hint >}}

Account methods

{{< api-method method="get" host="https://mastodon.example" path="/api/v1/admin/accounts" title="View accounts by criteria" >}} {{< api-method-description >}}

View accounts matching certain criteria for filtering, up to 100 at a time. Pagination may be done with the HTTP Link header in the response.

Returns: Admin::Account
OAuth: User token + admin:read:accounts
Version history:
2.9.1 - added

{{< endapi-method-description >}} {{< api-method-spec >}} {{< api-method-request >}} {{< api-method-headers >}} {{< api-method-parameter name="Authorization" type="string" required=true >}} Bearer <user token> {{< endapi-method-parameter >}} {{< endapi-method-headers >}} {{< api-method-query-parameters >}} {{< api-method-parameter name="local" type="boolean" required=false >}} Filter for local accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="remote" type="boolean" required=false >}} Filter for remote accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="by_domain" type="string" required=false >}} Filter by the given domain {{< endapi-method-parameter >}} {{< api-method-parameter name="active" type="boolean" required=false >}} Filter for currently active accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="pending" type="boolean" required=false >}} Filter for currently pending accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="disabled" type="boolean" required=false >}} Filter for currently disabled accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="silenced" type="boolean" required=false >}} Filter for currently silenced accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="suspended" type="boolean" required=false >}} Filter for currently suspended accounts? {{< endapi-method-parameter >}} {{< api-method-parameter name="username" type="string" required=false >}} Username to search for {{< endapi-method-parameter >}} {{< api-method-parameter name="display_name" type="string" required=false >}} Display name to search for {{< endapi-method-parameter >}} {{< api-method-parameter name="email" type="string" required=false >}} Lookup a user with this email {{< endapi-method-parameter >}} {{< api-method-parameter name="ip" type="string" required=false >}} Lookup users by this IP address {{< endapi-method-parameter >}} {{< api-method-parameter name="staff" type="boolean" required=false >}} Filter for staff accounts? {{< endapi-method-parameter >}} {{< endapi-method-query-parameters >}} {{< endapi-method-request >}} {{< api-method-response >}} {{< api-method-response-example httpCode=200 >}} {{< api-method-response-example-description >}} {{< endapi-method-response-example-description >}}

{{< endapi-method-response-example >}} {{< endapi-method-response >}} {{< endapi-method-spec >}} {{< endapi-method >}} {{< api-method method="get" host="https://mastodon.example" path="/api/v1/admin/accounts/:id" title="View a specific account" >}} {{< api-method-description >}}

View admin-level information about the given account.

Returns: Admin::Account
OAuth: User token + admin:read:accounts
Version history:
2.9.1 - added

{{< endapi-method-description >}} {{< api-method-spec >}} {{< api-method-request >}} {{< api-method-path-parameters >}} {{< api-method-parameter name=":id" type="string" required=true >}} ID of the account {{< endapi-method-parameter >}} {{< endapi-method-path-parameters >}} {{< api-method-headers >}} {{< api-method-parameter name="Authorization" type="string" required=true >}} Bearer <user token> {{< endapi-method-parameter >}} {{< endapi-method-headers >}} {{< endapi-method-request >}} {{< api-method-response >}} {{< api-method-response-example httpCode=200 >}} {{< api-method-response-example-description >}} {{< endapi-method-response-example-description >}}

{{< endapi-method-response-example >}} {{< endapi-method-response >}} {{< endapi-method-spec >}} {{< endapi-method >}} {{< api-method method="post" host="https://mastodon.example" path="/api/v1/admin/accounts/:account_id/action" title="Perform an action against an account" >}} {{< api-method-description >}}

Perform an action against an account and log this action in the moderation history.

Returns: empty object
OAuth: User token + admin:write:accounts
Version history:
2.9.1 - added

{{< endapi-method-description >}} {{< api-method-spec >}} {{< api-method-request >}} {{< api-method-path-parameters >}} {{< api-method-parameter name=":account_id" type="string" required=true >}} ID of the account {{< endapi-method-parameter >}} {{< endapi-method-path-parameters >}} {{< api-method-headers >}} {{< api-method-parameter name="Authorization" type="string" required=true >}} Bearer <user token> {{< endapi-method-parameter >}} {{< endapi-method-headers >}} {{< api-method-form-data-parameters >}} {{< api-method-parameter name="type" type="string" required=false >}} Type of action to be taken. Enumerable oneOf: none disable silence suspend {{< endapi-method-parameter >}} {{< api-method-parameter name="report_id" type="string" required=false >}} ID of an associated report that caused this action to be taken {{< endapi-method-parameter >}} {{< api-method-parameter name="warning_preset_id" type="string" required=false >}} ID of a preset warning {{< endapi-method-parameter >}} {{< api-method-parameter name="text" type="string" required=false >}} Additional text for clarification of why this action was taken {{< endapi-method-parameter >}} {{< api-method-parameter name="send_email_notification" type="boolean" required=false >}} Whether an email should be sent to the user with the above information. {{< endapi-method-parameter >}} {{< endapi-method-form-data-parameters >}} {{< endapi-method-request >}} {{< api-method-response >}} {{< api-method-response-example httpCode=200 >}} {{< api-method-response-example-description >}} {{< endapi-method-response-example-description >}}

{{< endapi-method-response-example >}} {{< endapi-method-response >}} {{< endapi-method-spec >}} {{< endapi-method >}} {{< api-method method="post" host="https://mastodon.example" path="/api/v1/admin/accounts/:id/approve" title="Approve pending account" >}} {{< api-method-description >}}

Approve the given local account if it is currently pending approval.