API:Changing wiki content
 | This page is part of the MediaWiki Action API documentation. |
Changing wiki content through the API is enabled by default as of MediaWiki 1.14; it can be disabled by setting $wgEnableWriteAPI = false; in "LocalSettings.php".
In MediaWiki 1.13 and earlier, you have to explicitly enable the write API with $wgEnableWriteAPI = true;
In MediaWiki 1.31 configuration parameter $wgEnableWriteAPI was deprecated and in future versions of MediaWiki it will no longer be possible to disable API access to the software.
Please see the appropriate subsection for detailed information for each module. Write modules generally require a POST method, where read modules usually use GET methods. Exceptions are noted on individual pages.
Read modules[edit]
| Module | Function |
|---|---|
| Changeauthenticationdata | Change authentication data for the current user. |
| Checktoken | Check the validity of a token from action=query&meta=tokens. |
| Clientlogin | Log in to the wiki using the interactive flow. |
| Compare | Get the difference between 2 pages. |
| Expandtemplates | Expands all templates within wikitext. |
| Feedcontributions | Returns a user's contributions feed. |
| Feedrecentchanges | Returns a recent changes feed. |
| Feedwatchlist | Returns a watchlist feed. |
| Help | Display help for the specified modules. |
| Linkaccount | Link an account from a third-party provider to the current user. |
| Login | Log in and get authentication cookies. |
| Logout | Log out and clear session data. |
| Opensearch | Search the wiki using the OpenSearch protocol. |
| Paraminfo | Obtain information about API modules. |
| Parse | Parses content and returns parser output. |
| Query | Fetch data from and about MediaWiki. |
| Removeauthenticationdata | Remove authentication data for the current user. |
| Rsd | Export an RSD (Really Simple Discovery) schema. |
| Stashedit | Prepare an edit in shared cache. |
| Tokens | Get tokens for data-modifying actions. |
| Unlinkaccount | Remove a linked third-party account from the current user. |
Write modules[edit]
| Module | Function |
|---|---|
| Block | Block a user. |
| Clearhasmsg | Clears the hasmsg flag for the current user.
|
| Createaccount | Create a new user account. |
| Delete | Delete a page. |
| Edit | Create and edit pages. |
| Emailuser | Email a user. |
| Filerevert | Revert a file to an old version. |
| Imagerotate | Rotate one or more images. |
| Import | Import a page from another wiki, or from an XML file. |
| Managetags | Perform management tasks relating to change tags. |
| Mergehistory | Merge page histories. |
| Move | Move a page. |
| Options | Change preferences of the current user. |
| Patrol | Patrol a page or revision. |
| Protect | Change the protection level of a page. |
| Purge | Purge the cache for the given titles. |
| Resetpassword | Send a password reset email to a user. |
| Revisiondelete | Delete and undelete revisions. |
| Rollback | Undo the last series of edits to a page by the last user. |
| Setnotificationtimestamp | Update the notification timestamp for watched pages. |
| Tag | Add or remove change tags from individual revisions or log entries. |
| Unblock | Unblock a user. |
| Undelete | Restore revisions of a deleted page. |
| Upload | Upload a file, or get the status of pending uploads. |
| Userrights | Change a user's group membership. |
| Watch | Add or remove pages from the current user's watchlist. |
Possible errors[edit]
Some wikis restrict the use of these modules to certain groups of users, or disallow it altogether. All aforementioned modules can return the following errors:
| Code | Info |
|---|---|
| noapiwrite | Editing of this wiki through the API is disabled. |
| writeapidenied | You're not allowed to edit this wiki through the API. |