---
error:
code: unknown_action
info: |
Unrecognized value for parameter 'action': query
*: |
******************************************************************
** **
** This is an auto-generated MediaWiki API documentation page **
** **
** Documentation and Examples: **
** http://www.mediawiki.org/wiki/API **
** **
******************************************************************
Status: All features shown on this page should be working, but the API
is still in active development, and may change at any time.
Make sure to monitor our mailing list for any updates.
Documentation: http://www.mediawiki.org/wiki/API
Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api
Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts
Parameters:
format - The format of the output
One value: json, jsonfm, php, phpfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm, rawfm, txt, txtfm, dbg, dbgfm
Default: xmlfm
action - What action you would like to perform
One value: login, logout, help, rollback, delete, undelete, protect, block, unblock, move, edit, emailuser, watch, patrol
Default: help
version - When showing help, include version for each module
maxlag - Maximum lag
smaxage - Set the s-maxage header to this many seconds. Errors are never cached
Default: 0
maxage - Set the max-age header to this many seconds. Errors are never cached
Default: 0
requestid - Request ID to distinguish requests. This will just be output back to you
*** *** *** *** *** *** *** *** *** *** Modules *** *** *** *** *** *** *** *** *** ***
* action=login (lg) *
This module is used to login and get the authentication tokens.
In the event of a successful log-in, a cookie will be attached
to your session. In the event of a failed log-in, you will not
be able to attempt another log-in through this method for 5 seconds.
This is to prevent password guessing by automated password crackers.
This module only accepts POST requests.
Parameters:
lgname - User Name
lgpassword - Password
lgdomain - Domain (optional)
Example:
api.php?action=login&lgname=user&lgpassword=password
* action=logout *
This module is used to logout and clear session data
Parameters:
Example:
api.php?action=logout
* action=help *
Display this help screen.
* action=rollback *
Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,
they will all be rolled back.
This module only accepts POST requests.
Parameters:
title - Title of the page you want to rollback.
user - Name of the user whose edits are to be rolled back. If set incorrectly, you'll get a badtoken error.
token - A rollback token previously retrieved through prop=revisions
summary - Custom edit summary. If not set, default summary will be used.
markbot - Mark the reverted edits and the revert as bot edits
Examples:
api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC
api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1
* action=delete *
Delete a page.
This module only accepts POST requests.
Parameters:
title - Title of the page you want to delete. Cannot be used together with pageid
pageid - Page ID of the page you want to delete. Cannot be used together with title
token - A delete token previously retrieved through prop=info
reason - Reason for the deletion. If not set, an automatically generated reason will be used.
watch - Add the page to your watchlist
unwatch - Remove the page from your watchlist
oldimage - The name of the old image to delete as provided by iiprop=archivename
Examples:
api.php?action=delete&title=Main%20Page&token=123ABC
api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move
* action=undelete *
Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be
retrieved through list=deletedrevs
This module only accepts POST requests.
Parameters:
title - Title of the page you want to restore.
token - An undelete token previously retrieved through list=deletedrevs
reason - Reason for restoring (optional)
Default:
timestamps - Timestamps of the revisions to restore. If not set, all revisions will be restored.
Examples:
api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page
api.php?action=undelete&title=Main%20Page&token=123ABC×tamps=20070703220045|20070702194856
* action=protect *
Change the protection level of a page.
This module only accepts POST requests.
Parameters:
title - Title of the page you want to (un)protect.
token - A protect token previously retrieved through prop=info
protections - Pipe-separated list of protection levels, formatted action=group (e.g. edit=sysop)
expiry - Expiry timestamps. If only one timestamp is set, it'll be used for all protections.
Use 'infinite', 'indefinite' or 'never', for a neverexpiring protection.
Default: infinite
reason - Reason for (un)protecting (optional)
Default:
cascade - Enable cascading protection (i.e. protect pages included in this page)
Ignored if not all protection levels are 'sysop' or 'protect'
Examples:
api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade&expiry=20070901163000|never
api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions
* action=block *
Block a user.
This module only accepts POST requests.
Parameters:
user - Username, IP address or IP range you want to block
token - A block token previously obtained through the gettoken parameter or prop=info
gettoken - If set, a block token will be returned, and no other action will be taken
expiry - Relative expiry time, e.g. '5 months' or '2 weeks'. If set to 'infinite', 'indefinite' or 'never', the block will never expire.
Default: never
reason - Reason for block (optional)
anononly - Block anonymous users only (i.e. disable anonymous edits for this IP)
nocreate - Prevent account creation
autoblock - Automatically block the last used IP address, and any subsequent IP addresses they try to login from
noemail - Prevent user from sending e-mail through the wiki. (Requires the "blockemail" right.)
hidename - Hide the username from the block log. (Requires the "hideuser" right.)
allowusertalk - Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit)
reblock - If the user is already blocked, overwrite the existing block
Examples:
api.php?action=block&user=123.5.5.12&expiry=3%20days&reason=First%20strike
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate&autoblock&noemail
* action=unblock *
Unblock a user.
This module only accepts POST requests.
Parameters:
id - ID of the block you want to unblock (obtained through list=blocks). Cannot be used together with user
user - Username, IP address or IP range you want to unblock. Cannot be used together with id
token - An unblock token previously obtained through the gettoken parameter or prop=info
gettoken - If set, an unblock token will be returned, and no other action will be taken
reason - Reason for unblock (optional)
Examples:
api.php?action=unblock&id=105
api.php?action=unblock&user=Bob&reason=Sorry%20Bob
* action=move *
Move a page.
This module only accepts POST requests.
Parameters:
from - Title of the page you want to move. Cannot be used together with fromid.
fromid - Page ID of the page you want to move. Cannot be used together with from.
to - Title you want to rename the page to.
token - A move token previously retrieved through prop=info
reason - Reason for the move (optional).
movetalk - Move the talk page, if it exists.
noredirect - Don't create a redirect
watch - Add the page and the redirect to your watchlist
unwatch - Remove the page and the redirect from your watchlist
Example:
api.php?action=move&from=Exampel&to=Example&token=123ABC&reason=Misspelled%20title&movetalk&noredirect
* action=edit *
Create and edit pages.
This module only accepts POST requests.
Parameters:
title - Page title
section - Section number. 0 for the top section, 'new' for a new section
text - Page content
token - Edit token. You can get one of these through prop=info
summary - Edit summary. Also section title when section=new
minor - Minor edit
notminor - Non-minor edit
bot - Mark this edit as bot
basetimestamp - Timestamp of the base revision (gotten through prop=revisions&rvprop=timestamp).
Used to detect edit conflicts; leave unset to ignore conflicts.
starttimestamp - Timestamp when you obtained the edit token.
Used to detect edit conflicts; leave unset to ignore conflicts.
recreate - Override any errors about the article having been deleted in the meantime
createonly - Don't edit the page if it exists already
nocreate - Throw an error if the page doesn't exist
captchaword - Answer to the CAPTCHA
captchaid - CAPTCHA ID from previous request
watch - Add the page to your watchlist
unwatch - Remove the page from your watchlist
md5 - The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated.
If set, the edit won't be done unless the hash is correct
prependtext - Add this text to the beginning of the page. Overrides text.
Don't use together with section: that won't do what you expect.
appendtext - Add this text to the end of the page. Overrides text
Examples:
Edit a page (anonymous user):
api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\
* action=emailuser *
Email a user.
This module only accepts POST requests.
Parameters:
target - User to send email to
subject - Subject header
text - Mail body
token - A token previously acquired via prop=info
ccme - Send a copy of this mail to me
Example:
api.php?action=emailuser&target=WikiSysop&text=Content
* action=watch *
Add or remove a page from/to the current user's watchlist
Parameters:
title - The page to (un)watch
unwatch - If set the page will be unwatched rather than watched
Examples:
api.php?action=watch&title=Main_Page
api.php?action=watch&title=Main_Page&unwatch
* action=patrol *
Patrol a page or revision.
Parameters:
token - Patrol token obtained from list=recentchanges
rcid - Recentchanges ID to patrol
Example:
api.php?action=patrol&token=123abc&rcid=230672766
*** *** *** *** *** *** *** *** *** *** Permissions *** *** *** *** *** *** *** *** *** ***
* writeapi *
Use of the write API
Granted to:
all, user, bot
* apihighlimits *
Use higher limits in API queries (Slow queries: 500 results; Fast queries: 5000 results). The limits for slow queries also apply to multivalue parameters.
Granted to:
bot, sysop
*** *** *** *** *** *** *** *** *** *** Formats *** *** *** *** *** *** *** *** *** ***
* format=json *
Output data in JSON format
Parameters:
callback - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=json
* format=jsonfm *
Output data in JSON format (pretty-print in HTML)
Parameters:
callback - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm
* format=php *
Output data in serialized PHP format
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=php
* format=phpfm *
Output data in serialized PHP format (pretty-print in HTML)
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm
* format=wddx *
Output data in WDDX format
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddx
* format=wddxfm *
Output data in WDDX format (pretty-print in HTML)
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=wddxfm
* format=xml *
Output data in XML format
Parameters:
xmldoublequote - If specified, double quotes all attributes and content.
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml
* format=xmlfm *
Output data in XML format (pretty-print in HTML)
Parameters:
xmldoublequote - If specified, double quotes all attributes and content.
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm
* format=yaml *
Output data in YAML format
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml
* format=yamlfm *
Output data in YAML format (pretty-print in HTML)
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm
* format=rawfm *
Output data with the debuging elements in JSON format (pretty-print in HTML)
Parameters:
callback - If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm
* format=txt *
Output data in PHP's print_r() format
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt
* format=txtfm *
Output data in PHP's print_r() format (pretty-print in HTML)
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm
* format=dbg *
Output data in PHP's var_export() format
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg
* format=dbgfm *
Output data in PHP's var_export() format (pretty-print in HTML)
Example:
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm
*** Credits: ***
API developers:
Roan Kattouw <Firstname>.<Lastname>@home.nl (lead developer Sep 2007-present)
Victor Vasiliev - vasilvv at gee mail dot com
Bryan Tong Minh - bryan . tongminh @ gmail . com
Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)
Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org
or file a bug report at http://bugzilla.wikimedia.org/