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

(main | regexblock)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: RegexBlock
  • Licence: GPL-2.0-or-later

Block users' names and IP addresses via regular expressions.

Parameters:
regex

The regular expression to block. Note that when the "exact" param is given in the URL, this is not treated as a regular expression but rather as a simple string.

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)
nocreate

Prevent account creation.

Type: boolean (details)
exact

Use exact matching to block the given name precisely as given (as opposed to treating it as a regular expression).

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
Examples:
Block the exact IP address "192.0.2.5" for three days with the reason "First strike"
api.php?action=regexblock&regex=192.0.2.5&expiry=3%20days&reason=First%20strike&exact=&token=123ABC [open in sandbox]
Block the regular expression "SpamUser.*" permanently, which blocks any and all users whose user name matches that expression, such as "SpamUser65", with the reason "Bad username" and also prevent any and all users whose user name matches the regular expression from creating new user accounts.
api.php?action=regexblock&regex=SpamUser.*&expiry=never&reason=Bad%20username&nocreate=&token=123ABC [open in sandbox]