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=globalblock

(main | globalblock)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: GlobalBlocking
License: GPL-2.0-or-later

Globally block or unblock a user.

Specific parameters:

Other general parameters are available.

id: ID of the global block to modify or unblock (obtained through list=globalblocks). Cannot be used together with target.; Type: integer
target: The target IP address or username. Cannot be used together with id.; Type: user, by any of username, IP, Temporary user and IP range
expiry: If specified, will block or reblock the user. Determines how long the block will last for, e.g. "5 months" or "2 weeks". If set to "infinite" or "indefinite" the block will never expire.; Type: expiry (details)
unblock: If specified, will unblock the user.; Type: boolean (details)
reason: The reason for blocking/unblocking.; This parameter is required.
anononly: Specify this if the block should only affect logged-out users globally.; Type: boolean (details)
allow-account-creation: Specify this if the global block should not prevent account creation.; Type: boolean (details)
enable-autoblock: Specify this if the global block should trigger global autoblocks.; Type: boolean (details)
modify: Specify this if the existing block on the target should be modified; Type: boolean (details)
alsolocal: Block the user locally as well. Cannot be used together with id.; Type: boolean (details)
localblockstalk: Revoke talk page access locally. Cannot be used together with id.; Type: boolean (details)
localblocksemail: Revoke email access locally. Cannot be used together with id.; Type: boolean (details)
localanononly: Specify this if the block should only affect logged-out users locally. Cannot be used together with id.; Type: boolean (details)
local-allow-account-creation: Specify this if the local block should not prevent account creation. Cannot be used together with id.; Type: boolean (details)
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Block 192.0.2.1 indefinitely with reason "Cross-wiki abuse": api.php?action=globalblock&target=192.0.2.1&expiry=indefinite&reason=Cross-wiki%20abuse&token=123ABC [open in sandbox]