API:Purge
From MediaWiki.org
| Language: | English • Deutsch • 日本語 • polski |
|---|
 |
This page is part of the MediaWiki action API documentation. |
MediaWiki action API
- Introduction and quick start
- FAQ
- Tutorial
- Formats
- Error reporting
- Restricting usage
- Cross-site requests
- Authentication
- Queries
- Searching (by title, content, coordinates...)
- Parsing wikitext and expanding templates
- Purging pages' caches
- Parameter information
- Changing wiki content
- Create and edit pages
- Move pages
- Merge 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
- Client code
- Asserting
| Purge | ||
|---|---|---|
| Purges the cache of one or more pages This module cannot be used as a Generator. |
||
| Prefix | none | |
| Required rights | purge | |
| Post only? | No | |
| Generated help | Current | |
| Version added |
|
|
Purging pages' caches[edit]
You can purge the cache of one or more pages using action=purge.
Parameters[edit]
titles: A list of titles. Can not be used together withpageidsorrevidspageids: A list of page IDs. Can not be used together withtitlesorrevids1.20+revids: A list of revision IDs. Can not be used together withtitlesorpageidsforcelinkupdate: If set, updates the link tablesforcerecursivelinkupdate: 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 purgeredirects: Automatically resolve redirectsconverttitles: Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.continue: When more results are available, use this to continue.
Examples[edit]
- 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
- Purging the cache of Main Page, Nonexistent and Talk:
| Result |
|---|
<?xml version="1.0" encoding="utf-8"?>
<api>
<purge>
<page ns="0" title="Main Page" purged="" />
<page ns="0" title="Nonexistent" missing="" />
<page title="Talk:" invalid="" />
</purge>
</api>
|
Possible errors[edit]
| Code | Info |
|---|---|
| cantpurge | Only users with the 'purge' right can purge pages via the API |
|
The following documentation is the output of Special:ApiHelp/purge, generated from purge's source code. |
action=purge
(main | purge)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Purge the cache for the given titles.
Requires a POST request if the user is not logged in.
Parameters:
- forcelinkupdate
-
Update the links tables.
- Type: boolean (details)
- forcerecursivelinkupdate
-
Update the links table, and update the links tables for any page that uses this page as a template.
- Type: boolean (details)
- continue
-
When more results are available, use this to continue.
- titles
-
A list of titles to work on.
- Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
- pageids
-
A list of page IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
- revids
-
A list of revision IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
- generator
-
Get the list of pages to work on by executing the specified query module.
Note: Generator parameter names must be prefixed with a "g", see examples.
- One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, messagecollection, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage
- redirects
-
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.
- Type: boolean (details)
- converttitles
-
Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz and zh.
- Type: boolean (details)
Examples:
- Purge the Main Page and the API page.
- api.php?action=purge&titles=Main_Page|API [open in sandbox]
- Purge the first 10 pages in the main namespace.
- api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [open in sandbox]
