MediaWiki API help

Which action to perform.

ask

API module to query Semantic MediaWiki using the ask language.

askargs

API module to query Semantic MediaWiki using the ask language as list of conditions, printouts and parameters.

block

Block a user.

bs-adminuser-store

Lists all users from the database with additional sensitive data. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-avatars-tasks

Uploading, generating and setting user avatars

bs-bookshelf-bookstore

Lists all chapters for a given book. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-bookshelf-manage

Provides tasks for book manipulation.

bs-bookshelf-mass-add-page-store

Provides pages that can be added by mass into a book.

bs-bookshelf-page-collection-store

Provides a collection of pages that can be added by mass into a book.

bs-bookshelf-store

Lists all books. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-category-store

Lists all categories. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-category-treestore

Lists the sub-categories of a specific category

bs-categorylinks-store

Lists all categories of a page inclusive link to the category page and marker for explicite and implicit categories.

bs-checklist-available-options-store

Lists all available options for checklist templates. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-checklist-tasks

Provides operations for Checklist extension

bs-checklist-template-store

Lists all templates that are valid checklist sources. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-configmanager-store

Manage stores

bs-configmanager-tasks

Manage tasks

bs-contextmenu-tasks

Provides the context menu items in context

bs-dashboards-store

Lists all available portlets

bs-dashboards-tasks

Saves dashboard configuration

bs-dashboards-widgets-tasks

Returns content for some dashboard widgets

bs-expiry-store

Provides a store for expires, that can be queried

bs-expiry-tasks

Provides tasks such as editing or deleting expiries

bs-extendedsearch-autocomplete

Returns autocomplete results from given query

bs-extendedsearch-query

Search the index

bs-extendedsearch-resultrelevance

Returns the relevance of search results

bs-extendedsearch-stats

Returns statistical data about the registered backends and their configured sources

bs-extendedsearch-triggerupdate

Trigger update of search index

bs-extendedsearch-type-store

Returns registered search types

bs-file-tasks

⧼apihelp-bs-file-tasks-summary⧽

bs-filebackend-store

Lists all files from the file backend. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-filehistory-store

⧼apihelp-bs-filehistory-store-summary⧽

bs-flaggedpages-store

Provides data for pages, that are under approval control

bs-group-store

Lists all groups except $wgImplicitGroups. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-groupmanager

Provides the tasks for the extension GroupManager.

bs-insertfile-license-store

Lists the licenses for the extension InsertFile.

bs-insertmagic-data-store

Lists all items for the InsertMagic dialog

bs-inserttemplate-store

Lists all templates. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-interwiki-store

Lists all interwiki links. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-interwikilinks-tasks

Provides the tasks for the extension InterWikiLinks.

bs-js-var-config

Provides an API endpoint for retrieving client-side configuration variables

bs-linker

Returns links to pages generated by Linker

bs-mypageassignment-store

Returns pages assigned to current user

bs-namespace-store

Lists all namespaces and arbitrary configuration. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-namespace-tasks

Allows modification of the namespace configuration.

bs-namespacecss-store

Lists namespaces and their possible CSS source page. Implements ExtJS Store parameters.

bs-nsfilerepo-connector

API endpoint for extension BlueSpiceNSFileRepoConnector

bs-nsfrc-tasks

API endpoint for extension BlueSpiceNSFileRepoConnector

bs-pageaccess-store

Control access on page level

bs-pageassignable-store

Returns the list of assignees

bs-pageassignment-store

Returns assignments of the specific page

bs-pageassignment-tasks

Get or edit the list of assignments for specific page

bs-pageauthors-store

List all authors of a page provided in the context

bs-pagetemplates-store

Lists all page templates. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-pagetemplates-tasks

Allows manipulation of page templates

bs-permissionmanager-tasks

Provides tasks for the PermissionManager

bs-ping-tasks

Ping task that provides continuous exchange of data

bs-privacy

Endpoint for all API actions regarding privacy

bs-privacy-get-all-consents

Endpoint for gettings consent information for all users

bs-privacy-get-requests

Endpoint for getting all pending requests

bs-rating-tasks

Executes common tasks for extension Rating

bs-ratingarticle-store

Delivers ratings for articles

bs-ratingarticlelike-store

Delivers recommendations for articles

bs-readconfirmation-tasks

API endpoint for extension ReadConfirmation

bs-readers-data-store

Get reader info of specific page.

bs-readers-page-readers-store

Gets all readers of all pages

bs-readers-revision-readers-store

Gets all readers of all revisions of a page

bs-readers-tasks

Provides common operations for Readers

bs-readers-users-store

Get all readers info of specific page.

bs-recentchanges-store

Lists all recent changes. Allows sorting, filtering and pagination. Implements store parameters.

bs-reminder-store

Provides a store for reminders, that can be queried

bs-reminder-tasks

Provides tasks such as editing or deleting reminders

bs-review-tasks

Allows manipulation of reviews

bs-reviewoverview-store

Lists an overview of review processes. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-reviewpossiblereviewers-store

Lists users that can be part of a review process. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-reviewtemplate-store

Provides review templates via API

bs-reviewworkflowhistory-store

⧼apihelp-bs-reviewworkflowhistory-store-summary⧽

bs-role-permission-store

Provide role description for the PermissionManager

bs-rss-standards-pages-store

Return List of available Pages for RSSFeeder

bs-rssfeeder-tasks

Provides common tasks for the RSSFeeder

bs-smartlist-tasks

API functions to serve portlet data for page and user statistics.

bs-smw-connector-ask-store

ExtJS-compatible store to execute semantic queries

bs-smw-connector-smw-property-store

⧼apihelp-bs-smw-connector-smw-property-store-summary⧽

bs-smw-connector-tree-ask-store

⧼apihelp-bs-smw-connector-tree-ask-store-summary⧽

bs-social-tasks

Provides tasks such as editing or deleting entities

bs-socialentity-store

Provides a search store for entities, that can be queried

bs-socialresolve-tasks

Provides tasks for editing the resolve status of entities

bs-socialstash-tasks

Provides tasks for editing the linked pages of entities

bs-socialtags-tasks

Provides tasks for editing the linked pages of entities

bs-socialtitlequery-store

Provides data for titles, that can be linked within an entity

bs-socialtopics-tasks

Provides tasks such as auto creating the discussion page

bs-socialwatch-tasks

Provides tasks for editing the watch status of entities

bs-task

Provides the API endpoint for executing registered tasks

bs-templatelinks-store

Lists all templates of a page inclusive link to the template.

bs-titlequery-store

Lists page titles and (optionally) namespace prefixes based on a query term. Implements ExtJS Store parameters.

bs-upload-license-store

Lists all available licences for a file upload

bs-usagetracker-store

Holds statistical data about extension use

bs-user-store

Lists all users from the database. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-userinfometa

Lists the given users meta information data

bs-usermanager-group-store

Provides the user manager tasks api for BlueSpice.

bs-usermanager-tasks

Provides operations for Checklist extension

bs-vec-restbase-mock

Provides a mock for RESTBase calls of VisualEditor

bs-vec-transformtohtml

Transforms WikiText to VisualEditor HTML

bs-vec-transformtowikitext

Transforms VisualEditor HTML to WikiText

bs-watchlist-store

Lists all watchlist entries. Allows sorting, filtering and pagination. Implements store parameters.

bs-wikiexplorer-store

Provides all data for the extension WikiExplorer

bs-wikipage-store

Lists all wiki pages. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

bs-wikipage-tasks

Provides common operations for WikiPages

bs-wikisubpage-treestore

Lists the subpages of a specific wikipage

categorytree

Internal module for the CategoryTree extension.

changeauthenticationdata

Change authentication data for the current user.

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.

compoundquery

⧼apihelp-compoundquery-summary⧽

createaccount

Create a new user account.

cspreport

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.

delete

Delete a page.

echomarkread

Mark notifications as read for the current user.

echomarkseen

Mark notifications as seen for the current user.

edit

Create and edit pages.

emailuser

Email a user.

embedvideo

⧼apihelp-embedvideo-summary⧽

expandtemplates

Expands all templates within wikitext.

ext.srf.slideshow.show

⧼apihelp-ext.srf.slideshow.show-summary⧽

feedcontributions

Returns a user contributions feed.

feedrecentchanges

Returns a recent changes feed.

feedwatchlist

Returns a watchlist feed.

filerevert

Revert a file to an old version.

flagconfig

Get basic information about review flag configuration for this site.

geocode

⧼apihelp-geocode-summary⧽

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.

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.

mergehistory

Merge page histories.

move

Move a page.

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.

pfautocomplete

Autocompletion used by the Page Forms extension.

pfautoedit

Create or edit a page using a form defined by the Page Forms extension.

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.

review

Review a revision by approving or de-approving it.

reviewactivity

Advertise or de-advertise yourself as reviewing an unreviewed page or unreviewed changes.

revisiondelete

Delete and undelete revisions.

rollback

Undo the last edit to the page.

rsd

Export an RSD (Really Simple Discovery) schema.

scribunto-console

Internal module for servicing XHR requests from the Scribunto console.

setnotificationtimestamp

Update the notification timestamp for watched pages.

setpagelanguage

Change the language of a page.

smwbrowse

API module to support browse activities for different entity types in Semantic MediaWiki.

smwinfo

API module to retrieve information about Semantic MediaWiki statistics and other meta information.

smwtask

API module to execute Semantic MediaWiki related tasks.

stabilize

Change page stability settings.

stashedit

Prepare an edit in shared cache.

tag

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

templatedata

Fetch data stored by the TemplateData extension.

unblock

Unblock a user.

undelete

Restore 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.

visualeditor

Returns HTML5 for a page from the Parsoid service.

visualeditoredit

Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).

watch

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

browsebyproperty

Deprecated. API module to retrieve information about a property or list of properties.

browsebysubject

Deprecated. API module to retrieve information about a subject.

tokens

Deprecated. Get tokens for data-modifying actions.

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 the user is logged in if set to user, 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 URI (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 whitelisted, 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.

Language to use for message translations. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify user to use the current user's language preference, or specify content to use this wiki's content language.

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 with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.

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