MediaWiki API help

Which action to perform. This parameter should be sent as part of the request URL (not the POST body) for ease of use in debugging, analytics, and request routing or filtering.

abusefiltercheckmatch

Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.

abusefilterchecksyntax

Check syntax of an AbuseFilter filter.

abusefilterevalexpression

Evaluates an AbuseFilter expression.

abusefilterunblockautopromote

Unblocks a user from receiving autopromotions due to an abusefilter consequence.

abuselogprivatedetails

View private details of an AbuseLog entry.

acquiretempusername

Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.

block

Block a user.

changeauthenticationdata

Change authentication data for the current user.

changecontentmodel

Change the content model of a page

checktoken

Check the validity of a token from action=query&meta=tokens.

clearhasmsg

Clears the hasmsg flag for the current user.

clientlogin

Log in to the wiki using the interactive flow.

compare

Get the difference between two pages.

createaccount

Create a new user account.

csdeletecomment

Delete a comment. Either pageid or title must be provided.

csdeletereply

Delete a reply. Either pageid or title must be provided.

cseditcomment

Edit an existing comment. Either pageid or title must be provided.

cseditreply

Edit an existing reply. Either pageid or title must be provided.

cspostcomment

Post a new comment.

cspostreply

Post a new reply.

cspreviewcomment

Preview comment wikitext as HTML without posting a comment.

csquerycomment

Return details of a comment. Either pageid or title must be provided.

csqueryreply

Return details of a reply. Either pageid or title must be provided.

csunwatch

Unwatch a comment to no longer be notified when it receives replies

csvote

Vote (up, down, or neutral) on a comment.

cswatch

Watch a comment to be notified when it receives replies

delete

Delete a page.

detectfileextension

Detect a supported image or PDF extension from a URL or its Content-Type header.

echocreateevent

Manually trigger a notification to a user

echomarkread

Mark notifications as read for the current user.

echomarkseen

Mark notifications as seen for the current user.

echomute

Mute or unmute notifications from certain users or pages.

edit

Create and edit pages.

emailuser

Email a user.

expandtemplates

Expands all templates within wikitext.

favorite

Add or remove a page from/to the current user's favorite list

feedcontributions

Returns a user's contributions feed.

feedrecentchanges

Returns a recent changes feed.

feedwatchlist

Returns a watchlist feed.

filerevert

Revert a file to an old version.

help

Display help for the specified modules.

imagerotate

Rotate one or more images.

import

Import a page from another wiki, or from an XML file.

languagesearch

Search for language names in any script.

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.

managetags

Perform management tasks relating to change tags.

mdbnames

Resolve case-insensitive MixesDB category names and return their canonical title, type, and mix count.

mergehistory

Merge page histories.

mixesdb_player_search

Find MixesDB pages containing a player URL.

mixesdbaddmixtemplate

Render an AddMix template preview without saving a page.

mixesdbeditformatreview

Review proposed mix-page wikitext and return formatting suggestions without saving.

mixesdbnativeplayer

Render a player preview and return its HTML and required ResourceLoader modules.

mixesdbnewmixes

Get the next fixed batch of latest mixes.

mixesdbplayerhealthaction

Preview, recheck, replace, comment out, or add a replacement for a page player.

mixesdbplayerhealthreview

Accept, reject, or undo proposed player replacements.

mixesdbplayerhealthsearch

Search a provider for replacements for a broken player URL.

mixesdbremotehelp

Get rendered README help or userscript version metadata from a configured source.

mixesdbrenderlinks

Render local page titles as MediaWiki HTML links.

mixesdbsearchjsonld

Search MixesDB and return structured results with JSON-LD metadata.

mixesdbsearchmeta

List supported MixesDB search keywords, context groups, and sort orders.

mixesdbsearchresultshtml

Search MixesDB and return rendered result HTML.

mixesdbsearchtypeahead

Suggest values for a MixesDB search field.

mixesdbtrackid

Retrieve cached TrackId data or link a cached player URL to a MixesDB page.

mixesdbtrackidbatch

Retrieve cached TrackId data and linked pages for multiple player URLs.

mixesdbtrackidquery

Browse cached TrackId rows with filtering, sorting, and pagination.

mixesdbtrackidrefresh

Refresh an existing cached TrackId record from the TrackId API.

mixesdbtrackidupdate

Process inbound TrackId email notifications and update the cached last-parsed timestamp.

mixesdbuserlinks

Get safe, viewer-specific decorations for user contribution links.

move

Move a page.

ogg_to_mp3

Convert an uploaded OGG audio file to an MP3 fallback.

opensearch

Search the wiki using the OpenSearch protocol.

options

Change preferences of the current user.

paraminfo

Obtain information about API modules.

parse

Parses content and returns parser output.

patrol

Patrol a page or revision.

protect

Change the protection level of a page.

purge

Purge the cache for the given titles.

query

Fetch data from and about MediaWiki.

removeauthenticationdata

Remove authentication data for the current user.

resetpassword

Send a password reset email to a user.

revisiondelete

Delete and undelete revisions.

rollback

Undo the last edit to the page.

rsd

Export an RSD (Really Simple Discovery) schema.

scaleway_webhook

Receive Scaleway email bounce notifications.

setnotificationtimestamp

Update the notification timestamp for watched pages.

setpagelanguage

Change the language of a page.

soundcloud

Authorize the SoundCloud integration or synchronize its playlists.

tag

Add or remove change tags from individual revisions or log entries.

thank

Send a thank-you notification to an editor.

titleblacklist

Validate a page title, filename, or username against the TitleBlacklist.

tracklist_api

Look up cached track matches or update track-to-YouTube associations.

tracklist_api_batch

Run multiple track lookup or association requests in one call.

unblock

Unblock a user.

undelete

Undelete revisions of a deleted page.

unlinkaccount

Remove a linked third-party account from the current user.

upload

Upload a file, or get the status of pending uploads.

userrights

Change a user's group membership.

validatepassword

Validate a password against the wiki's password policies.

watch

Add or remove pages from the current user's watchlist.

youtube_search

Search YouTube through the cached MixesDB search proxy.

cirrus-check-sanity

Internal. Reports on the correctness of a range of page ids in the search index

cirrus-config-dump

Internal. Dump of CirrusSearch configuration.

cirrus-profiles-dump

Internal. Dump of CirrusSearch profiles for this wiki.

cirrus-schema-dump

Internal. Dump of CirrusSearch schema (settings and mappings) for this wiki.

cspreport

Internal. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.

stashedit

Internal. Prepare an edit in shared cache.

The format of the output.

json

Output data in JSON format.

jsonfm

Output data in JSON format (pretty-print in HTML).

none

Output nothing.

php

Output data in serialized PHP format.

phpfm

Output data in serialized PHP format (pretty-print in HTML).

rawfm

Output data, including debugging elements, in JSON format (pretty-print in HTML).

xml

Output data in XML format.

xmlfm

Output data in XML format (pretty-print in HTML).

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.

Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.

Set the max-age HTTP cache control header to this many seconds. Errors are never cached.

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.

Verify the current user is the named user.

Any value given here will be included in the response. May be used to distinguish requests.

Include the hostname that served the request in the results.

Include the current timestamp in the result.

Include the languages used for uselang and errorlang in the result.

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 en.wikipedia.org or 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.

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.

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.

Variant of the language. Only works if the base language supports variant conversion.

Format to use for warning and error text output

plaintext

Wikitext with HTML tags removed and entities replaced.

wikitext

Unparsed wikitext.

html

HTML

raw

Message key and parameters.

none

No text output, only the error codes.

bc

Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.

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.

If given, error texts will use locally-customized messages from the MediaWiki namespace.