MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=block
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
Block a user.
- user
Username, IP address, or IP range to block.
- This parameter is required.
- 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).
- nocreate
Prevent account creation.
- autoblock
Automatically block the last used IP address, and any subsequent IP addresses they try to login from.
- noemail
Prevent user from sending email through the wiki. (Requires the
blockemailright).- hidename
Hide the username from the block log. (Requires the
hideuserright).- allowusertalk
Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).
- reblock
If the user is already blocked, overwrite the existing block.
- watchuser
Watch the user and talk pages of the user or IP address.
- 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 reason First strike.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC
- Block user Vandal indefinitely with reason Vandalism, and prevent new account creation and email sending.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC