MediaWiki Action API

https://www.mediawiki.org/wiki/API:
Admin
The MediaWiki Action API is a web service that allows developers to access and interact with...
Tokens:5,016
Snippets:116
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Main module

Source: https://www.mediawiki.org/wiki/API:Action_API

This snippet documents the main module parameters of the MediaWiki Action API. These parameters are common to all API requests and control caching, authentication, response format, and other global behaviors.

```APIDOC
## Main module

### Description
This module defines the main parameters for the MediaWiki Action API. These parameters are common to all API requests and control caching, authentication, response format, and other global behaviors.

### Parameters
#### Query Parameters
- **maxlag** (integer) - Optional - Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
- **smaxage** (integer) - Optional - Set the `s-maxage` HTTP cache control header to this many seconds. Errors are never cached. The value must be no less than 0. Default: 0.
- **maxage** (integer) - Optional - Set the `max-age` HTTP cache control header to this many seconds. Errors are never cached. The value must be no less than 0. Default: 0.
- **assert** (string) - Optional - Verify that the user is logged in (including possibly as a temporary user) if set to `user`, _not_ logged in if set to `anon`, or has the bot user right if `bot`. One of the following values: anon, bot, user.
- **assertuser** (user) - Optional - Verify the current user is the named user. Type: user, by any of username and Temporary user.
- **requestid** (string) - Optional - Any value given here will be included in the response. May be used to distinguish requests.
- **servedby** (boolean) - Optional - Include the hostname that served the request in the results.
- **curtimestamp** (boolean) - Optional - Include the current timestamp in the result.
- **responselanginfo** (boolean) - Optional - Include the languages used for uselang and errorlang in the result.
- **origin** (string) - Optional - When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URL (not the POST body). For authenticated requests, this must match one of the origins in the `Origin` header exactly, so it has to be set to something like `https://en.wikipedia.org` or `https://meta.wikimedia.org`. If this parameter does not match the `Origin` header, a 403 response will be returned. If this parameter matches the `Origin` header and the origin is allowed, the `Access-Control-Allow-Origin` and `Access-Control-Allow-Credentials` headers will be set. For non-authenticated requests, specify the value `*`. This will cause the `Access-Control-Allow-Origin` header to be set, but `Access-Control-Allow-Credentials` will be `false` and all user-specific data will be restricted.
- **crossorigin** (boolean) - Optional - When accessing the API using a cross-domain AJAX request (CORS) and using a session provider that is safe against cross-site request forgery (CSRF) attacks (such as OAuth), use this instead of `origin=*` to make the request authenticated (i.e., not logged out). This must be included in any pre-flight request, and therefore must be part of the request URL (not the POST body). Note that most session providers, including standard cookie-based sessions, do not support authenticated CORS and cannot be used with this parameter.
- **uselang** (string) - Optional - Language to use for message translations. `action=query&meta=siteinfo&siprop=languages` returns a list of language codes. You can specify `user` to use the current user's language preference or `content` to use this wiki's content language. Default: user.
- **variant** (string) - Optional - Variant of the language. Only works if the base language supports variant conversion.
- **errorformat** (string) - Optional - Format to use for warning and error text output. One of the following values: bc, html, none, plaintext, raw, wikitext. Default: bc.
- **errorlang** (string) - Optional - Language to use for warnings and errors. `action=query&meta=siteinfo&siprop=languages` returns a list of language codes. Specify `content` to use this wiki's content language or `uselang` to use the same value as the uselang parameter. Default: uselang.
- **errorsuselocal** (boolean) - Optional - If given, error texts will use locally-customized messages from the MediaWiki namespace.
- **centralauthtoken** (string) - Optional - When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use `action=centralauthtoken` on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 60 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body). On this wiki the expected value is a JSON Web Token, which may be validated by proxy servers in front of MediaWiki. If the token has expired or is otherwise invalid, you may receive a HTTP error from a proxy in a different format than a normal API error.
```
Tokens:
Raw