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
action=watch
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0-or-later
Add or remove pages from the current user's watchlist.
- title
- Deprecated.
The page to (un)watch. Use titles instead.
- expiry
Expiry timestamp to be applied to all given pages. Omit this parameter entirely to leave any current expiries unchanged.
- Type: expiry (details)
- unwatch
If set the page will be unwatched rather than watched.
- Type: boolean (details)
- continue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- titles
A list of titles to work on.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- 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 clients that are allowed higher limits).
- revids
A list of revision IDs to work on. Note that almost all query modules will convert revision IDs to the corresponding page ID and work on the latest revision instead. Only prop=revisions uses exact revisions for its response.
- Type: list of integers
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- 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.
- allcategories
- Enumerate all categories.
- alldeletedrevisions
- List all deleted revisions by a user or in a namespace.
- allfileusages
- List all file usages, including non-existing.
- allimages
- Enumerate all images sequentially.
- alllinks
- Enumerate all links that point to a given namespace.
- allpages
- Enumerate all pages sequentially in a given namespace.
- allredirects
- List all redirects to a namespace.
- allrevisions
- List all revisions.
- alltransclusions
- List all transclusions (pages embedded using {{x}}), including non-existing.
- backlinks
- Find all pages that link to the given page.
- categories
- List all categories the pages belong to.
- categorymembers
- List all pages in a given category.
- deletedrevisions
- Get deleted revision information.
- duplicatefiles
- List all files that are duplicates of the given files based on hash values.
- embeddedin
- Find all pages that embed (transclude) the given title.
- exturlusage
- Enumerate pages that contain a given URL.
- fileusage
- Find all pages that use the given files.
- images
- Returns all files contained on the given pages.
- imageusage
- Find all pages that use the given image title.
- iwbacklinks
- Find all pages that link to the given interwiki link.
- langbacklinks
- Find all pages that link to the given language link.
- links
- Returns all links from the given pages.
- linkshere
- Find all pages that link to the given pages.
- messagecollection
- Query MessageCollection about translations.
- mostviewed
- Lists the most viewed pages (based on last day's pageview count).
- pageswithprop
- List all pages using a given page property.
- prefixsearch
- Perform a prefix search for page titles.
- protectedtitles
- List all titles protected from creation.
- querypage
- Get a list provided by a QueryPage-based special page.
- random
- Get a set of random pages.
- recentchanges
- Enumerate recent changes.
- redirects
- Returns all redirects to the given pages.
- revisions
- Get revision information.
- search
- Perform a full text search.
- templates
- Returns all pages transcluded on the given pages.
- transcludedin
- Find all pages that transclude the given pages.
- watchlist
- Get recent changes to pages in the current user's watchlist.
- watchlistraw
- Get all pages on the current user's watchlist.
- wblistentityusage
- Returns all pages that use the given entity IDs.
- readinglistentries
- Internal. List the pages of a certain list.
- 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, mostviewed, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage, readinglistentries
- 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 ban, en, crh, gan, iu, ku, mni, sh, shi, sr, tg, tly, uz, wuu, zgh and zh.
- Type: boolean (details)
- token
A "watch" token retrieved from action=query&meta=tokens
- This parameter is required.
- Watch the page MediaWiki.
- api.php?action=watch&titles=MediaWiki&token=123ABC [open in sandbox]
- Watch the pages MediaWiki, Foo, and Bar for one month.
- api.php?action=watch&titles=MediaWiki|Foo|Bar&expiry=1%20month&token=123ABC [open in sandbox]
- Unwatch the page MediaWiki.
- api.php?action=watch&titles=MediaWiki&unwatch=&token=123ABC [open in sandbox]
- Watch the first few pages in the main namespace.
- api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC [open in sandbox]