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

list=globalblocks (bg)

(main | query | globalblocks)
  • This module requires read rights.
  • Source: GlobalBlocking
  • Licence: GPL-2.0-or-later

List all globally blocked IP addresses.

Specific parameters:
Other general parameters are available.
bgstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
bgend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
bgdir

In which direction to enumerate:

One of the following values: newer, older
Default: older
bgids

Pipe-separated list of block IDs to list.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
bgaddresses

Pipe-separated list of IP addresses to search for.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
bgip

Get all blocks applying to this IP address or CIDR range, including range blocks. Cannot be used together with bgaddresses. CIDR ranges broader than /16 are not accepted.

bglimit

The maximum amount of blocks to list.

Type: integer or max
The value must be between 1 and 500.
Default: 10
bgprop

Which properties to get.

Values (separate with | or alternative): address, by, expiry, id, range, reason, timestamp
Default: id|address|by|timestamp|expiry|reason
Examples:
List all global blocks
api.php?action=query&list=globalblocks [open in sandbox]
List global blocks applying to IP address 192.0.2.18
api.php?action=query&list=globalblocks&bgip=192.0.2.18 [open in sandbox]