---
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
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
*** *** *** *** *** *** *** *** *** *** 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.
*** *** *** *** *** *** *** *** *** *** 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
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/