MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
list=blocks (bk)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
List all blocked users and IP addresses.
- bkstart
The timestamp to start enumerating from.
- Type: timestamp (allowed formats)
- bkend
The timestamp to stop enumerating at.
- Type: timestamp (allowed formats)
- bkdir
In which direction to enumerate:
- newer
- List oldest first. Note: bkstart has to be before bkend.
- older
- List newest first (default). Note: bkstart has to be later than bkend.
- One of the following values: newer, older
- Default: older
- bkids
List of block IDs to list (optional).
- Type: list of integers
- Separate values with |. Maximum number of values is 50 (500 for bots).
- bkusers
List of users to search for (optional).
- Separate values with |. Maximum number of values is 50 (500 for bots).
- bkip
Get all blocks applying to this IP or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.
- bklimit
The maximum number of blocks to list.
- No more than 500 (5 000 for bots) allowed.
- Type: integer or max
- Default: 10
- bkprop
Which properties to get:
- id
- Adds the ID of the block.
- user
- Adds the username of the blocked user.
- userid
- Adds the user ID of the blocked user.
- by
- Adds the username of the blocking user.
- byid
- Adds the user ID of the blocking user.
- timestamp
- Adds the timestamp of when the block was given.
- expiry
- Adds the timestamp of when the block expires.
- reason
- Adds the reason given for the block.
- range
- Adds the range of IP addresses affected by the block.
- flags
- Tags the ban with (autoblock, anononly, etc.).
- Values (separate with |): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
- Default: id|user|by|timestamp|expiry|reason|flags
- bkshow
Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.
- Values (separate with |): account, !account, temp, !temp, ip, !ip, range, !range
- bkcontinue
When more results are available, use this to continue.
- List blocks.
- api.php?action=query&list=blocks
- List blocks of users Alice and Bob.
- api.php?action=query&list=blocks&bkusers=Alice|Bob