View source for Extension:GlobalBlocking/API

== Global blocking ==
Allows you to create a new block, remove a block, or modify one.

=== Parameters ===
*{{ApiParam|target|Target IP address/range|required=1}}
*{{ApiParam|expiry|How long block should last for}}
*{{ApiParam|unblock|If set, will unblock the address/range}}
*{{ApiParam|reason|(un)block reason|required=1}}
*{{ApiParam|anononly|If set, the block will only affect anonymous users}}
*{{ApiParam|modify|If set, the block will modify an existing block}}
*{{ApiParam|token|Edit token|required=1}}

=== Example ===
Note: Request must be POSTed.

{{ApiEx
|desc=Blocking 127.0.0.1 indefinitely with the reason of "Cross wiki abuse"
|p1=action=globalblock
|p2=target=127.0.0.1
|p3=expiry=indefinite
|p4=reason=Cross%20wiki%20abuse
|p5=token=TOKEN
|result=<syntaxhighlight lang="xml"><?xml version="1.0"?>
<api>
  <globalblock user="127.0.0.1" blocked="" expiry="infinite" />
</api></syntaxhighlight>}}

== List global blocks ==
View a list of currently blocked IP addresses/ranges.

=== Parameters ===
*<code>bgstart</code>: The timestamp to start enumerating from
*<code>bgend</code>: The timestamp to stop enumerating at
*<code>bgdir</code>: The direction in which to enumerate (older, newer)
*<code>bgids</code>: Pipe-separated list of block IDs to list (optional)
*<code>bgaddresses</code>: Pipe-separated list of addresses to search for (optional)
*<code>bgip</code>: Get all blocks applying to this IP or CIDR range, including range blocks. (Cannot be used together with bkusers. IPv4 CIDR ranges broader than /16 are not accepted; however, IPv6 ranges can be of any size less than /4)
*<code>bglimit</code>: The maximum number of blocks to list
*<code>bgprop</code>: Which properties to get (id|address|by|timestamp|expiry|reason|range)

===Errors codes===
* <code>cidrtoobroad</code>: CIDR ranges broader than /16 are not accepted.
* <code>invalidtitle</code>: Bad title 'title'.
* <code>readapidenied</code>: You need read permission to use this module.

=== Example ===
{{ApiEx
|desc=List all global blocks
|p1=action=query
|p2=list=globalblocks
|p3=bgprop=id{{!}}address
|result=
<syntaxhighlight lang="xml">
<api>
  <query-continue>
    <globalblocks bgstart="2009-10-03T12:10:59Z" />
  </query-continue>
  <query>
    <globalblocks>
      <block id="2301" address="82.49.115.227" />
      <block id="2297" address="59.86.157.24" anononly="" />
      <block id="2296" address="83.79.31.175" anononly="" />
      <block id="2287" address="81.18.116.66" />
      <block id="2286" address="141.223.237.76" />
      <block id="2280" address="125.184.11.164" />
      <block id="2279" address="124.197.47.74" />
      <block id="2278" address="115.139.25.18" />
      <block id="2277" address="111.92.160.26" />
      <block id="2276" address="89.248.172.146" />
    </globalblocks>
  </query>
</api>
</syntaxhighlight>}}

{{Api help|globalblock}}