MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=block
(main | block)
This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0-or-later
Block a user.
- user
User to block.
Type: user, by any of
username
,IP
,IP range
anduser ID (e.g. "#12345")
- userid
Deprecated.
Specify user=#ID instead.
Type: integer
- expiry
Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.
Default: never
- reason
Reason for block.
Default: (empty)
- anononly
Block anonymous users only (i.e. disable anonymous edits for this IP address).
Type: boolean (details)
- nocreate
Prevent account creation.
Type: boolean (details)
- autoblock
Automatically block the last used IP address, and any subsequent IP addresses they try to login from.
Type: boolean (details)
- noemail
Prevent user from sending email through the wiki. (Requires the
blockemailright).Type: boolean (details)
- hidename
Hide the username from the block log. (Requires the
hideuserright).Type: boolean (details)
- allowusertalk
Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).
Type: boolean (details)
- reblock
If the user is already blocked, overwrite the existing block.
Type: boolean (details)
- watchuser
Watch the user's or IP address's user and talk pages.
Type: boolean (details)
- tags
Change tags to apply to the entry in the block log.
Values (separate with | or alternative):
- partial
Block user from specific pages or namespaces rather than the entire site.
Type: boolean (details)
- pagerestrictions
List of titles to block the user from editing. Only applies when partial is set to true.
Type: page title
Separate values with | or alternative.
Maximum number of values is 10.
Only accepts pages that exist.
- namespacerestrictions
List of namespace IDs to block the user from editing. Only applies when partial is set to true.
Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
To specify all values, use *.
- token
A "csrf" token retrieved from action=query&meta=tokens
This parameter is required.
Block IP address 192.0.2.5 for three days with a reason.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC
[open in sandbox]
Block user Vandal indefinitely with a reason, and prevent new account creation and email sending.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC
[open in sandbox]