API:Main module

From MediaWiki.org
Jump to: navigation, search
This page is part of the MediaWiki action API documentation.

MediaWiki action API

v · d · e

The main module includes parameters that can be used for any API request.

Parameters[edit]

  • action: Which action to perform.
  • format: The format of the output.
  • maxlag: 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. See Manual: Maxlag parameter for more information. Type: integer
  • maxage: Set the max-age HTTP cache control header to this many seconds. Errors are never cached. Type: integer
  • smaxage: Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached. Type: integer
  • assert: Verify the user is logged in if set to user, or has the bot user right if bot.
  • requestid: Any value given here will be included in the response. May be used to distinguish requests. 1.14+
  • servedby: Include the hostname that served the request in the results. Type: boolean 1.17+
  • curtimestamp: Include the current timestamp in the result. Not included in an error . Type: boolean
  • origin: 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 URI (not the POST body). 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 whitelisted, an Access-Control-Allow-Origin header will be set.
  • uselang: The language code to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from API:siteinfo with siprop=languages, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{LangSwitch}} template at the Commons, or generally by things dependent on {{int:Lang}}. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design. Type: string
  • centralauthtoken: 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 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body)

Error codes[edit]

  • maxlag – Waiting for host: x seconds lagged.
  • maxlag – Waiting for a database server: x seconds lagged.
  • readonly – The wiki is currently in read-only mode.
  • unknown_action – The API requires a valid action parameter.
  • unknown_format – Unrecognized format: format.

See also[edit]