API:Purge

This page is part of the MediaWiki API documentation.

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • Etiquette and usage limits
• Tutorial
• Formats
• Error reporting
• Restricting usage
• Cross-site requests
• Authentication
  • Login
  • Logout
  • Account creation
• Queries
  • Meta information
  • Properties
  • Lists
• Searching (by title, content, coordinates...)
• Parsing wikitext and expanding templates
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Mark revisions of watched pages as visited
  • Send email
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
  • User options
  • Tokens
  • Page language
• Watchlist feed
• Wikidata
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
  • Localisation
• Client code
• Asserting

MediaWiki version:

1.14

Purging pages' caches

You can purge the cache of one or more pages using action=purge.

Parameters

• titles/pageids/revids: A list of titles/page IDs/revision IDs
• forcelinkupdate: If set, updates the link tables
• forcerecursivelinkupdate: Like forcelinkupdate, but also do forcelinkupdate on any page that transcludes the current page. This is akin to making an edit to a template. Note that the job queue is used for this operation, so there may be a slight delay when doing this for pages used a large number of times.
• generator: Use a generator to get the list of pages to purge

Examples

1. Purge file with inconsistent external links table on commons: https://commons.wikimedia.org/w/api.php?action=purge&titles=File:Masopust_držíme_18.jpg&forcelinkupdate
2. Purging the cache of Main Page, Nonexistent and Talk:

api.php?action=purge&titles=Main_Page|Nonexistent|Talk: [try in ApiSandbox]

Possible errors

Code	Info
cantpurge	Only users with the 'purge' right can purge pages via the API