API:Restricting API usage
 |
This page is part of the MediaWiki API documentation. |
| Language: | English • Deutsch • polski • русский |
|---|
Quick overview:
- Quick start guide
- FAQ
- Tutorial
- Formats
- Error reporting
- Restricting usage
- Authentication
- Queries
- Search suggestions
- Expanding templates and rendering
- Purging pages' caches
- Parameter information
- Changing wiki content
- Watchlist feed
- Extensions
- Using the API in MediaWiki and extensions
- Miscellaneous
- Implementation
- Client code
There are several ways to restrict usage of (certain parts of) the API to certain groups of users, or to disable it altogether. Some of these require changing group permissions.
Disabling the entire API
You can disable the API as a whole by setting $wgEnableAPI = false; in LocalSettings.php. The API is enabled by default.
Disabling the write API
You can disable all write modules by setting $wgEnableWriteAPI = false; in LocalSettings.php. The write API is enabled by default as of MediaWiki 1.14, and disabled by default in older versions.
Restricting access to the write API
You can deny certain groups the right to use the write API by denying them the writeapi right. By default, all groups have the writeapi right; however, both the writeapi right and $wgEnableWriteAPI = true; are required in order to use the write API.
Disabling modules
You can disable individual modules for all users by adding a line to LocalSettings.php. Exactly what to add depends on the type of module you want to disable:
- For
action=modules, use$wgAPIModules['modulename'] = 'ApiDisabled'; - For
prop=modules, use$wgAPIPropModules['modulename'] = 'ApiQueryDisabled'; - For
list=modules, use$wgAPIListModules['modulename'] = 'ApiQueryDisabled'; - For
meta=modules, use$wgAPIMetaModules['modulename'] = 'ApiQueryDisabled';
Last modified on 23 January 2012, at 18:34