For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/api/extensions/globalblocks/overview.md.
  • English
  • GlobalBlocking

    Interfaces

    InterfaceDescription
    ApiGlobalBlockOne global block record. bgprop controls which fields appear. From MediaWiki 1.43 the flag booleans below are real booleans (false included), emitted together with bgprop=target (also for the deprecated bgprop=address); earlier versions emit a flag only when the option applies, regardless of bgprop.
    ApiGlobalBlockErrorResponseFailure response of action=globalblock: the legacy error.globalblock array, written under the root error key rather than as a standard ApiErrorResponse — see ApiGlobalBlockLegacyError.
    ApiGlobalBlockLegacyErrorOne entry of the legacy error.globalblock array that action=globalblock writes when a block or unblock fails. Unlike every other module, this one reports the failure in-band under the root error key ({ error: { globalblock: [...] } }) instead of a top-level error object, so that error carries no code/info. The shape is the same under every errorformat.
    ApiGlobalBlockResponseResponse of action=globalblock. A failed block/unblock is reported in-band under the root error key; with alsolocal=1, a failed local block is reported the same way while the global block still succeeds, so both keys can appear together — see ApiGlobalBlockLegacyError.
    ApiGlobalBlockResultResult object of action=globalblock. Which fields appear depends on the branch: blocking emits ApiGlobalBlockResult.blocked plus the applied options and ApiGlobalBlockResult.expiry; unblocking emits ApiGlobalBlockResult.unblocked.