MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Main module

Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

Parameters:
action

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-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
⧼apihelp-bs-flaggedpages-store-summary⧽
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-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-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-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-reviewextended-tasks
API endpoint for extension ReviewExtended
bs-reviewextendedtemplate-store
Provides review templates via API
bs-reviewextendedworkflowhistory-store
⧼apihelp-bs-reviewextendedworkflowhistory-store-summary⧽
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-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-smw-property-store
⧼apihelp-bs-smw-connector-smw-property-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-socialwatch-tasks
Provides tasks for editing the watch status of entities
bs-statistics-available-diagrams-store
Provides a store with available diagrams
bs-statistics-search-options-store
Provides a store with available search options
bs-statistics-tasks
Provides common tasks for statistics
bs-task
Provides the API endpoint for executing registered tasks
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-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 activties 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.
One of the following values: ask, askargs, block, bs-adminuser-store, bs-avatars-tasks, bs-bookshelf-bookstore, bs-bookshelf-manage, bs-bookshelf-mass-add-page-store, bs-bookshelf-page-collection-store, bs-bookshelf-store, bs-category-store, bs-category-treestore, bs-checklist-available-options-store, bs-checklist-tasks, bs-checklist-template-store, bs-configmanager-store, bs-configmanager-tasks, bs-contextmenu-tasks, bs-dashboards-store, bs-dashboards-tasks, bs-dashboards-widgets-tasks, bs-expiry-store, bs-expiry-tasks, bs-extendedsearch-autocomplete, bs-extendedsearch-query, bs-extendedsearch-resultrelevance, bs-extendedsearch-stats, bs-extendedsearch-triggerupdate, bs-extendedsearch-type-store, bs-file-tasks, bs-filebackend-store, bs-filehistory-store, bs-flaggedpages-store, bs-group-store, bs-groupmanager, bs-insertfile-license-store, bs-insertmagic-data-store, bs-inserttemplate-store, bs-interwiki-store, bs-interwikilinks-tasks, bs-mypageassignment-store, bs-namespace-store, bs-namespace-tasks, bs-namespacecss-store, bs-nsfilerepo-connector, bs-nsfrc-tasks, bs-pageaccess-store, bs-pageassignable-store, bs-pageassignment-store, bs-pageassignment-tasks, bs-pagetemplates-store, bs-pagetemplates-tasks, bs-permissionmanager-tasks, bs-ping-tasks, bs-privacy, bs-privacy-get-all-consents, bs-privacy-get-requests, bs-rating-tasks, bs-ratingarticle-store, bs-ratingarticlelike-store, bs-readconfirmation-tasks, bs-readers-data-store, bs-readers-page-readers-store, bs-readers-users-store, bs-recentchanges-store, bs-reminder-store, bs-reminder-tasks, bs-review-tasks, bs-reviewextended-tasks, bs-reviewextendedtemplate-store, bs-reviewextendedworkflowhistory-store, bs-reviewoverview-store, bs-reviewpossiblereviewers-store, bs-role-permission-store, bs-rss-standards-pages-store, bs-rssfeeder-tasks, bs-smartlist-tasks, bs-smw-connector-smw-property-store, bs-social-tasks, bs-socialentity-store, bs-socialresolve-tasks, bs-socialstash-tasks, bs-socialtags-tasks, bs-socialtitlequery-store, bs-socialwatch-tasks, bs-statistics-available-diagrams-store, bs-statistics-search-options-store, bs-statistics-tasks, bs-task, bs-titlequery-store, bs-upload-license-store, bs-usagetracker-store, bs-user-store, bs-usermanager-group-store, bs-usermanager-tasks, bs-vec-restbase-mock, bs-vec-transformtohtml, bs-vec-transformtowikitext, bs-watchlist-store, bs-wikiexplorer-store, bs-wikipage-store, bs-wikipage-tasks, bs-wikisubpage-treestore, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, compoundquery, createaccount, cspreport, delete, echomarkread, echomarkseen, edit, emailuser, embedvideo, expandtemplates, ext.srf.slideshow.show, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flagconfig, geocode, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, pfautocomplete, pfautoedit, protect, purge, query, removeauthenticationdata, resetpassword, review, reviewactivity, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, setpagelanguage, smwbrowse, smwinfo, smwtask, stabilize, stashedit, tag, templatedata, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, visualeditor, visualeditoredit, watch, browsebyproperty, browsebysubject, tokens
Default: help
format

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).
One of the following values: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Default: jsonfm
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
smaxage

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

Type: integer
Default: 0
maxage

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

Type: integer
Default: 0
assert

Verify the user is logged in if set to user, or has the bot user right if bot.

One of the following values: user, bot
assertuser

Verify the current user is the named user.

Type: user name
requestid

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

servedby

Include the hostname that served the request in the results.

Type: boolean (details)
curtimestamp

Include the current timestamp in the result.

Type: boolean (details)
responselanginfo

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

Type: boolean (details)
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).

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.

uselang

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.

Default: user
errorformat

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.
One of the following values: plaintext, wikitext, html, raw, none, bc
Default: bc
errorlang

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.

Default: uselang
errorsuselocal

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

Type: boolean (details)
Permissions:
writeapi
Use of the write API
Granted to: bot, sysop, bureaucrat, editor, reviewer, autoreview and Book_publisher
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot and sysop

action=ask

(main | ask)
  • This module requires read rights.
  • Source: Semantic MediaWiki
  • License: GPL-2.0-or-later

API module to query Semantic MediaWiki using the ask language.

Parameters:
query

The query string in ask-language

This parameter is required.
api_version

Output formatting:

2
Backwards-compatible format using {} for the result list.
3
Experimental format using [] as result list.
One of the following values: 2, 3
Default: 2

action=askargs

  • This module requires read rights.
  • Source: Semantic MediaWiki
  • License: GPL-2.0-or-later

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

Parameters:
conditions

The query conditions, i.e. the requirements for a subject to be included

This parameter is required.
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
printouts

The query printouts, i.e. the properties to show per subject

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
Default: (empty)
parameters

The query parameters, i.e. all non-condition and non-printout arguments

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
Default: (empty)
api_version

Output formatting:

2
Backwards-compatible format using {} for the result list.
3
Experimental format using [] as result list.
One of the following values: 2, 3
Default: 2

action=block

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Block a user.

Parameters:
user

Username, IP address, or IP address range to block. Cannot be used together with userid

Type: user name
userid

User ID to block. Cannot be used together with user.

Type: integer
expiry

Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.

Default: never
reason

Reason for block.

Default: (empty)
anononly

Block anonymous users only (i.e. disable anonymous edits for this IP address).

Type: boolean (details)
nocreate

Prevent account creation.

Type: boolean (details)
autoblock

Automatically block the last used IP address, and any subsequent IP addresses they try to login from.

Type: boolean (details)
noemail

Prevent user from sending email through the wiki. (Requires the blockemail right).

Type: boolean (details)
hidename

Hide the username from the block log. (Requires the hideuser right).

Type: boolean (details)
allowusertalk

Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).

Type: boolean (details)
reblock

If the user is already blocked, overwrite the existing block.

Type: boolean (details)
watchuser

Watch the user's or IP address's user and talk pages.

Type: boolean (details)
tags

Change tags to apply to the entry in the block log.

Values (separate with | or alternative):
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
Examples:
Block IP address 192.0.2.5 for three days with reason First strike.
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [open in sandbox]
Block user Vandal indefinitely with reason Vandalism, and prevent new account creation and email sending.
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [open in sandbox]

action=browsebyproperty

  • This module is deprecated.
  • This module requires read rights.
  • Source: Semantic MediaWiki
  • License: GPL-2.0-or-later

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

Parameters:
property

To match a specific property

limit

To specify the size of the list request

Default: 50
lang

To specify a specific language used for some attributes (description etc.)

listonly

To specify that only a property list is returned without further details

action=browsebysubject

  • This module is deprecated.
  • This module requires read rights.
  • Source: Semantic MediaWiki
  • License: GPL-2.0-or-later

API module to retrieve information about a subject.

Parameters:
subject

The subject to be queried

This parameter is required.
ns
(no description)
Type: integer
Default: 0
iw
(no description)
Default: (empty)
subobject

A particular subobject id for the related subject

Default: (empty)
type
(no description)
Default: (empty)
options
(no description)
Default: (empty)

action=bs-adminuser-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-avatars-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceAvatars
  • License: GPL-3.0-only

Uploading, generating and setting user avatars

Parameters:
task

The task that should be executed

uploadFile
Schema, parameter examples
generateAvatar
Schema, parameter examples
setUserImage
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: uploadFile, generateAvatar, setUserImage, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-bookshelf-bookstore

  • This module requires read rights.
  • Source: BlueSpiceBookshelf
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

node

Speficies a node for which a subchapter list should be provided.

book

Specifies the book for which a chapter list should be provided.

action=bs-bookshelf-manage

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceBookshelfUI
  • License: GPL-3.0-only

Provides tasks for book manipulation.

Parameters:
task

The task that should be executed

deleteBook
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: deleteBook, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-bookshelf-mass-add-page-store

  • This module requires read rights.
  • Source: BlueSpiceBookshelfUI
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 9999
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

root

Root value based on which to return pages

This parameter is required.
type

Type of source for mass add

This parameter is required.

action=bs-bookshelf-page-collection-store

  • This module requires read rights.
  • Source: BlueSpiceBookshelfUI
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-bookshelf-store

  • This module requires read rights.
  • Source: BlueSpiceBookshelf
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-category-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-category-treestore

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Lists the sub-categories of a specific category

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

node

A path of categories separated by slash

Default: (empty)

action=bs-checklist-available-options-store

  • This module requires read rights.
  • Source: BlueSpiceChecklist
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-checklist-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceChecklist
  • License: GPL-3.0-only

Provides operations for Checklist extension

Parameters:
task

The task that should be executed

doChangeCheckItem
Schema, parameter examples
saveOptionsList
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: doChangeCheckItem, saveOptionsList, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-checklist-template-store

  • This module requires read rights.
  • Source: BlueSpiceChecklist
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-configmanager-store

  • This module requires read rights.
  • Source: BlueSpiceConfigManager
  • License: GPL-3.0-only

Manage stores

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-configmanager-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceConfigManager
  • License: GPL-3.0-only

Manage tasks

Parameters:
task

The task that should be executed

save
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: save, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-contextmenu-tasks

  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceContextMenu
  • License: GPL-3.0-only

Provides the context menu items in context

Parameters:
task

The task that should be executed

getMenuItems
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getMenuItems, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-dashboards-store

  • This module requires read rights.
  • Source: BlueSpiceDashboards
  • License: GPL-3.0-only

Lists all available portlets

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-dashboards-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceDashboards
  • License: GPL-3.0-only

Saves dashboard configuration

Parameters:
task

The task that should be executed

saveAdminDashboardConfig
Schema, parameter examples
saveUserDashboardConfig
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: saveAdminDashboardConfig, saveUserDashboardConfig, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-dashboards-widgets-tasks

  • This module requires read rights.
  • This module requires write rights.
  • Source: BlueSpiceDashboards
  • License: GPL-3.0-only

Returns content for some dashboard widgets

Parameters:
task

The task that should be executed

wikipage
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: wikipage, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
_dc

Cache control parameter. Used by ExtJS.

action=bs-expiry-store

  • This module requires read rights.
  • Source: BlueSpiceExpiry
  • License: GPL-3.0-only

Provides a store for expires, that can be queried

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-expiry-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceExpiry
  • License: GPL-3.0-only

Provides tasks such as editing or deleting expiries

Parameters:
task

The task that should be executed

saveExpiry
Schema, parameter examples
deleteExpiry
Schema, parameter examples
getDetailsForExpiry
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: saveExpiry, deleteExpiry, getDetailsForExpiry, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-extendedsearch-autocomplete

  • This module requires read rights.
  • Source: BlueSpiceExtendedSearch
  • License: GPL-3.0-only

Returns autocomplete results from given query

Parameters:
q

The query term

This parameter is required.
backend

Key of the configured backend that should be queried

Default: local
searchData

JSON decoded string containing additional information of the context of the search

This parameter is required.
secondaryRequestData

JSON decoded string containing additional secondary information of the context of the search

action=bs-extendedsearch-query

  • This module requires read rights.
  • Source: BlueSpiceExtendedSearch
  • License: GPL-3.0-only

Search the index

Parameters:
q

The query term

This parameter is required.
backend

Key of the configured backend that should be queried

Default: local
searchTerm

Term for which the search is conducted for

action=bs-extendedsearch-resultrelevance

  • This module requires read rights.
  • Source: BlueSpiceExtendedSearch
  • License: GPL-3.0-only

Returns the relevance of search results

Parameter:
relevanceData

JSON decoded string containing additional information of the context of the search

This parameter is required.

action=bs-extendedsearch-stats

  • This module requires read rights.
  • Source: BlueSpiceExtendedSearch
  • License: GPL-3.0-only

Returns statistical data about the registered backends and their configured sources

Parameter:
stats

A list of statistics that should be returned

Default: []

action=bs-extendedsearch-triggerupdate

  • This module requires read rights.
  • Source: BlueSpiceExtendedSearch
  • License: GPL-3.0-only

Trigger update of search index

Parameters:
backend

Key of the configured backend that should be queried

Default: local
source

One or more sources within the specified backend separated by pipe. If empty, all available sources will be queried.

This parameter is required.
title

Title of the page the update should be triggered

This parameter is required.
params

Additional parameters for the query

Default: []

action=bs-extendedsearch-type-store

  • This module requires read rights.
  • Source: BlueSpiceExtendedSearch
  • License: GPL-3.0-only

Returns registered search types

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-file-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceWebDAVClientIntegration
  • License: GPL-3.0-only

BSApiTasksBase: This should be implemented by subclass

Parameters:
task

The task that should be executed

getLock
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getLock, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-filebackend-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: [{"property":"file_timestamp","direction":"DESC"}]
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-filehistory-store

  • This module requires read rights.
  • Source: BlueSpiceWebDAVClientIntegration
  • License: GPL-3.0-only
Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-flaggedpages-store

  • This module requires read rights.
  • Source: BlueSpiceFlaggedRevsConnector
  • License: GPL-3.0-only
Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-group-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-groupmanager

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceGroupManager
  • License: GPL-3.0-only

Provides the tasks for the extension GroupManager.

Parameters:
task

The task that should be executed

addGroup
Schema, parameter examples
editGroup
Schema, parameter examples
removeGroup
Schema, parameter examples
removeGroups
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: addGroup, editGroup, removeGroup, removeGroups, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-insertfile-license-store

  • This module requires read rights.
  • Source: BlueSpiceInsertFile
  • License: GPL-3.0-only

Lists the licenses for the extension InsertFile.

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-insertmagic-data-store

  • This module requires read rights.
  • Source: BlueSpiceInsertMagic
  • License: GPL-3.0-only

Lists all items for the InsertMagic dialog

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-inserttemplate-store

  • This module requires read rights.
  • Source: BlueSpiceInsertTemplate
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-interwiki-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceInterWikiLinks
  • License: GPL-3.0-only

Provides the tasks for the extension InterWikiLinks.

Parameters:
task

The task that should be executed

editInterWikiLink
Schema, parameter examples
removeInterWikiLink
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: editInterWikiLink, removeInterWikiLink, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-mypageassignment-store

  • This module requires read rights.
  • Source: BlueSpicePageAssignments
  • License: GPL-3.0-only

Returns pages assigned to current user

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-namespace-store

  • This module requires read rights.
  • Source: BlueSpiceNamespaceManager
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-namespace-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceNamespaceManager
  • License: GPL-3.0-only

Allows modification of the namespace configuration.

Parameters:
task

The task that should be executed

add
Schema, parameter examples
edit
Schema, parameter examples
remove
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: add, edit, remove, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-namespacecss-store

  • This module requires read rights.
  • Source: BlueSpiceNamespaceCSS
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-nsfilerepo-connector

  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceNSFileRepoConnector
  • License: GPL-3.0-only

API endpoint for extension BlueSpiceNSFileRepoConnector

Parameters:
task

The task that should be executed

getPossibleNamespaces
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getPossibleNamespaces, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-nsfrc-tasks

  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceNSFileRepoConnector
  • License: GPL-3.0-only

API endpoint for extension BlueSpiceNSFileRepoConnector

Parameters:
task

The task that should be executed

getPossibleNamespaces
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getPossibleNamespaces, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-pageaccess-store

  • This module requires read rights.
  • Source: BlueSpicePageAccess
  • License: GPL-3.0-only

Control access on page level

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-pageassignable-store

  • This module requires read rights.
  • Source: BlueSpicePageAssignments
  • License: GPL-3.0-only

Returns the list of assignees

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-pageassignment-store

  • This module requires read rights.
  • Source: BlueSpicePageAssignments
  • License: GPL-3.0-only

Returns assignments of the specific page

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-pageassignment-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpicePageAssignments
  • License: GPL-3.0-only

Get or edit the list of assignments for specific page

Parameters:
task

The task that should be executed

edit
Schema, parameter examples
getForPage
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: edit, getForPage, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-pagetemplates-store

  • This module requires read rights.
  • Source: BlueSpicePageTemplates
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-pagetemplates-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpicePageTemplates
  • License: GPL-3.0-only

Allows manipulation of page templates

Parameters:
task

The task that should be executed

doEditTemplate
Schema, parameter examples
doDeleteTemplates
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: doEditTemplate, doDeleteTemplates, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-permissionmanager-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpicePermissionManager
  • License: GPL-3.0-only

Provides tasks for the PermissionManager

Parameters:
task

The task that should be executed

saveRoles
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: saveRoles, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-ping-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Ping task that provides continuous exchange of data

Parameters:
task

The task that should be executed

ping
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: ping, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-privacy

  • This module requires read rights.
  • Source: BlueSpicePrivacy
  • License: GPL-3.0-only

Endpoint for all API actions regarding privacy

Parameters:
module

Requested module to execute action on

This parameter is required.
func

Function to execute withing the requested module

This parameter is required.
data

Data passed to the requested function

action=bs-privacy-get-all-consents

  • This module requires read rights.
  • Source: BlueSpicePrivacy
  • License: GPL-3.0-only

Endpoint for gettings consent information for all users

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-privacy-get-requests

  • This module requires read rights.
  • Source: BlueSpicePrivacy
  • License: GPL-3.0-only

Endpoint for getting all pending requests

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-rating-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceRating
  • License: GPL-3.0-only

Executes common tasks for extension Rating

Parameters:
task

The task that should be executed

vote
Schema, parameter examples
reload
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: vote, reload, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-ratingarticle-store

  • This module requires read rights.
  • Source: BlueSpiceRating
  • License: GPL-3.0-only

Delivers ratings for articles

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-ratingarticlelike-store

  • This module requires read rights.
  • Source: BlueSpiceRating
  • License: GPL-3.0-only

Delivers recommendations for articles

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-readconfirmation-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceReadConfirmation
  • License: GPL-3.0-only

API endpoint for extension ReadConfirmation

Parameters:
task

The task that should be executed

confirm
Schema, parameter examples
check
Schema, parameter examples
remind
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: confirm, check, remind, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-readers-data-store

  • This module requires read rights.
  • Source: BlueSpiceReaders
  • License: GPL-3.0-only

Get reader info of specific page.

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-readers-page-readers-store

  • This module requires read rights.
  • Source: BlueSpiceReaders
  • License: GPL-3.0-only

Gets all readers of all pages

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-readers-users-store

  • This module requires read rights.
  • Source: BlueSpiceReaders
  • License: GPL-3.0-only

Get all readers info of specific page.

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-recentchanges-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-reminder-store

  • This module requires read rights.
  • Source: BlueSpiceReminder
  • License: GPL-3.0-only

Provides a store for reminders, that can be queried

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-reminder-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceReminder
  • License: GPL-3.0-only

Provides tasks such as editing or deleting reminders

Parameters:
task

The task that should be executed

deleteReminder
Schema, parameter examples
saveReminder
Schema, parameter examples
getDetailsForReminder
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: deleteReminder, saveReminder, getDetailsForReminder, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-review-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceReview
  • License: GPL-3.0-only

Allows manipulation of reviews

Parameters:
task

The task that should be executed

editReview
Schema, parameter examples
deleteReview
Schema, parameter examples
vote
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: editReview, deleteReview, vote, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-reviewextended-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceReviewExtended
  • License: GPL-3.0-only

API endpoint for extension ReviewExtended

Parameters:
task

The task that should be executed

redelegate
Schema, parameter examples
delegate
Schema, parameter examples
saveTemplate
Schema, parameter examples
deleteTemplate
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: redelegate, delegate, saveTemplate, deleteTemplate, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-reviewextendedtemplate-store

  • This module requires read rights.
  • Source: BlueSpiceReviewExtended
  • License: GPL-3.0-only

Provides review templates via API

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-reviewextendedworkflowhistory-store

  • This module requires read rights.
  • Source: BlueSpiceReviewExtended
  • License: GPL-3.0-only
Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-reviewoverview-store

  • This module requires read rights.
  • Source: BlueSpiceReview
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

userID

Filters the list review processes by user iduserID

Type: integer
Default: 0

action=bs-reviewpossiblereviewers-store

  • This module requires read rights.
  • Source: BlueSpiceReview
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

articleId

Filters the list of users by permissions for articleId

This parameter is required.
Type: integer
Default: 0

action=bs-role-permission-store

  • This module requires read rights.
  • Source: BlueSpicePermissionManager
  • License: GPL-3.0-only

Provide role description for the PermissionManager

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

role
(no description)
This parameter is required.
Default: (empty)

action=bs-rss-standards-pages-store

  • This module requires read rights.
  • Source: BlueSpiceRSSFeeder
  • License: GPL-3.0-only

Return List of available Pages for RSSFeeder

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-rssfeeder-tasks

  • This module requires read rights.
  • This module requires write rights.
  • Source: BlueSpiceRSSFeeder
  • License: GPL-3.0-only

Provides common tasks for the RSSFeeder

Parameters:
task

The task that should be executed

getRSS
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getRSS, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json

action=bs-smartlist-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceSmartList
  • License: GPL-3.0-only

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

Parameters:
task

The task that should be executed

getMostVisitedPages
Schema, parameter examples
getMostEditedPages
Schema, parameter examples
getMostActivePortlet
Schema, parameter examples
getYourEditsPortlet
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getMostVisitedPages, getMostEditedPages, getMostActivePortlet, getYourEditsPortlet, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-smw-connector-smw-property-store

  • This module requires read rights.
  • Source: BlueSpiceSMWConnector
  • License: GPL-3.0-only
Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-social-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceSocial
  • License: GPL-3.0-only

Provides tasks such as editing or deleting entities

Parameters:
task

The task that should be executed

getEntities
Schema, parameter examples
getEntity
Schema, parameter examples
editEntity
Schema, parameter examples
deleteEntity
Schema, parameter examples
getConfigs
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getEntities, getEntity, editEntity, deleteEntity, getConfigs, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-socialentity-store

  • This module requires read rights.
  • Source: BlueSpiceSocial
  • License: GPL-3.0-only

Provides a search store for entities, that can be queried

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-socialresolve-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceSocialResolve
  • License: GPL-3.0-only

Provides tasks for editing the resolve status of entities

Parameters:
task

The task that should be executed

resolve
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: resolve, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-socialstash-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceSocialWikiPage
  • License: GPL-3.0-only

Provides tasks for editing the linked pages of entities

Parameters:
task

The task that should be executed

addFiles
Schema, parameter examples
removeFiles
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: addFiles, removeFiles, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-socialtags-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceSocialTags
  • License: GPL-3.0-only

Provides tasks for editing the linked pages of entities

Parameters:
task

The task that should be executed

editTags
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: editTags, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-socialtitlequery-store

  • This module requires read rights.
  • Source: BlueSpiceSocial
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

options

Arbitrary options to configure the store in format of a JSON string

Default: {}

action=bs-socialwatch-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceSocialWatch
  • License: GPL-3.0-only

Provides tasks for editing the watch status of entities

Parameters:
task

The task that should be executed

editWatch
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: editWatch, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-statistics-available-diagrams-store

  • This module requires read rights.
  • Source: BlueSpiceExtendedStatistics
  • License: GPL-3.0-only

Provides a store with available diagrams

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-statistics-search-options-store

  • This module requires read rights.
  • Source: BlueSpiceExtendedStatistics
  • License: GPL-3.0-only

Provides a store with available search options

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-statistics-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceExtendedStatistics
  • License: GPL-3.0-only

Provides common tasks for statistics

Parameters:
task

The task that should be executed

getData
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getData, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-task

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Provides the API endpoint for executing registered tasks

Parameters:
task

The task that should be executed

This parameter is required.
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json

action=bs-titlequery-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

options

Arbitrary options to configure the store in format of a JSON string

Default: {}

action=bs-upload-license-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Lists all available licences for a file upload

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-usagetracker-store

  • This module requires read rights.
  • Source: BlueSpiceUsageTracker
  • License: GPL-3.0-only

Holds statistical data about extension use

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-user-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-usermanager-group-store

  • This module requires read rights.
  • Source: BlueSpiceUserManager
  • License: GPL-3.0-only

Provides the user manager tasks api for BlueSpice.

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-usermanager-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceUserManager
  • License: GPL-3.0-only

Provides operations for Checklist extension

Parameters:
task

The task that should be executed

addUser
Schema, parameter examples
editUser
Schema, parameter examples
deleteUser
Schema, parameter examples
disableUser
Schema, parameter examples
enableUser
Schema, parameter examples
setUserGroups
Schema, parameter examples
editPassword
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: addUser, editUser, deleteUser, disableUser, enableUser, setUserGroups, editPassword, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-vec-restbase-mock

  • This module is internal or unstable. Its operation may change without notice.
  • This module requires read rights.
  • Source: BlueSpiceVisualEditorConnector
  • License: GPL-3.0-only

Provides a mock for RESTBase calls of VisualEditor

Parameters:
path

RESTBase path to be mocked

This parameter is required.
wikitext

Wikitext to be processed

action=bs-vec-transformtohtml

  • This module is internal or unstable. Its operation may change without notice.
  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceVisualEditorConnector
  • License: GPL-3.0-only

Transforms WikiText to VisualEditor HTML

Parameters:
wikitext

WikiText, that should be transformed to VisualEditor HTML

This parameter is required.
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-vec-transformtowikitext

  • This module is internal or unstable. Its operation may change without notice.
  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceVisualEditorConnector
  • License: GPL-3.0-only

Transforms VisualEditor HTML to WikiText

Parameters:
html

VisualEditor HTML, that should be transformed to WikiText

This parameter is required.
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-watchlist-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

Default: {}

action=bs-wikiexplorer-store

  • This module requires read rights.
  • Source: BlueSpiceWikiExplorer
  • License: GPL-3.0-only

Provides all data for the extension WikiExplorer

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

metaLoaded

API parameter to indicate whether the MetaData has already been loaded.

Type: boolean (details)

action=bs-wikipage-store

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

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

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

action=bs-wikipage-tasks

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Provides common operations for WikiPages

Parameters:
task

The task that should be executed

setCategories
Schema, parameter examples
getExplicitCategories
Schema, parameter examples
addCategories
Schema, parameter examples
removeCategories
Schema, parameter examples
getDiscussionCount
Schema, parameter examples
getTemplateTree
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: setCategories, getExplicitCategories, addCategories, removeCategories, getDiscussionCount, getTemplateTree, getUserTaskPermissions
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

format

The format of the result

One of the following values: json, jsonfm
Default: json
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=bs-wikisubpage-treestore

  • This module requires read rights.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Lists the subpages of a specific wikipage

Parameters:
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 25
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

node

The prefixed title of the wikipage

Default: (empty)
options

List of options

Default: {}

action=categorytree

  • This module is internal or unstable. Its operation may change without notice.
  • This module requires read rights.
  • Source: CategoryTree
  • License: GPL-2.0-or-later

Internal module for the CategoryTree extension.

Parameters:
category

Title in the category namespace, prefix will be ignored if given.

This parameter is required.
options

Options for the CategoryTree constructor as a JSON object. The depth option defaults to 1.

action=changeauthenticationdata (changeauth)

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Change authentication data for the current user.

Parameters:
changeauthrequest

Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=change.

This parameter is required.
changeauthtoken

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=change (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=checktoken

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

Parameters:
type

Type of token being tested.

This parameter is required.
One of the following values: createaccount, csrf, login, patrol, rollback, userrights, watch
token

Token to test.

This parameter is required.
maxtokenage

Maximum allowed age of the token, in seconds.

Type: integer

action=clearhasmsg

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Clears the hasmsg flag for the current user.

Example:
Clear the hasmsg flag for the current user.
api.php?action=clearhasmsg [open in sandbox]

action=clientlogin (login)

  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Log in to the wiki using the interactive flow.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=login, and a login token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying loginreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with logincontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to loginreturnurl. Then post to this module with logincontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
Parameters:
loginrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
loginmessageformat

Format to use for returning messages.

One of the following values: html, wikitext, raw, none
Default: wikitext
loginmergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)
loginpreservestate

Preserve state from a previous failed login attempt, if possible.

Type: boolean (details)
loginreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a logincontinue request to this API module.

logincontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or loginreturnurl is required.

Type: boolean (details)
logintoken

A "login" token retrieved from action=query&meta=tokens

This parameter is required.
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=login (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
Examples:
Start the process of logging in to the wiki as user Example with password ExamplePassword.
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [open in sandbox]
Continue logging in after a UI response for two-factor auth, supplying an OATHToken of 987654.
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [open in sandbox]

action=compare

Get the difference between two pages.

A revision number, a page title, a page ID, text, or a relative reference for both "from" and "to" must be passed.

Parameters:
fromtitle

First title to compare.

fromid

First page ID to compare.

Type: integer
fromrev

First revision to compare.

Type: integer
fromtext

Use this text instead of the content of the revision specified by fromtitle, fromid or fromrev.

fromsection

Only use the specified section of the specified 'from' content.

frompst

Do a pre-save transform on fromtext.

Type: boolean (details)
fromcontentformat

Content serialization format of fromtext.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
fromcontentmodel

Content model of fromtext. If not supplied, it will be guessed based on the other parameters.

One of the following values: Scribunto, GadgetDefinition, sanitized-css, wikitext, javascript, json, css, text, smw/schema, BSSocial, BSSocialProfile, BSSocialDiscussion
totitle

Second title to compare.

toid

Second page ID to compare.

Type: integer
torev

Second revision to compare.

Type: integer
torelative

Use a revision relative to the revision determined from fromtitle, fromid or fromrev. All of the other 'to' options will be ignored.

One of the following values: prev, next, cur
totext

Use this text instead of the content of the revision specified by totitle, toid or torev.

tosection

Only use the specified section of the specified 'to' content.

topst

Do a pre-save transform on totext.

Type: boolean (details)
tocontentformat

Content serialization format of totext.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
tocontentmodel

Content model of totext. If not supplied, it will be guessed based on the other parameters.

One of the following values: Scribunto, GadgetDefinition, sanitized-css, wikitext, javascript, json, css, text, smw/schema, BSSocial, BSSocialProfile, BSSocialDiscussion
prop

Which pieces of information to get.

diff
The diff HTML.
diffsize
The size of the diff HTML, in bytes.
rel
The revision IDs of the revision previous to 'from' and after 'to', if any.
ids
The page and revision IDs of the 'from' and 'to' revisions.
title
The page titles of the 'from' and 'to' revisions.
user
The user name and ID of the 'from' and 'to' revisions.
comment
The comment on the 'from' and 'to' revisions.
parsedcomment
The parsed comment on the 'from' and 'to' revisions.
size
The size of the 'from' and 'to' revisions.
Values (separate with | or alternative): diff, diffsize, rel, ids, title, user, comment, parsedcomment, size
Default: diff|ids|title
Example:
Create a diff between revision 1 and 2.
api.php?action=compare&fromrev=1&torev=2 [open in sandbox]

action=compoundquery

  • This module requires read rights.
  • Source: Semantic Compound Queries
  • License: GPL-2.0-or-later

API module to query SMW by providing a multiple queries in the ask language.

Parameter:
query

The multiple queries string in ask-language

This parameter is required.

action=createaccount (create)

  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Create a new user account.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=create, and a createaccount token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying createreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with createcontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to createreturnurl. Then post to this module with createcontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
Parameters:
createrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=create or from a previous response from this module.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
createmessageformat

Format to use for returning messages.

One of the following values: html, wikitext, raw, none
Default: wikitext
createmergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)
createpreservestate

Preserve state from a previous failed login attempt, if possible.

If action=query&meta=authmanagerinfo returned true for hasprimarypreservedstate, requests marked as primary-required should be omitted. If it returned a non-empty value for preservedusername, that username must be used for the username parameter.

Type: boolean (details)
createreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or createcontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a createcontinue request to this API module.

createcontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or createreturnurl is required.

Type: boolean (details)
createtoken

A "createaccount" token retrieved from action=query&meta=tokens

This parameter is required.
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=create (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=cspreport

  • This module is internal or unstable. Its operation may change without notice.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

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.

Parameters:
reportonly

Mark as being a report from a monitoring policy, not an enforced policy

Type: boolean (details)
source

What generated the CSP header that triggered this report

Default: internal

action=delete

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Delete a page.

Parameters:
title

Title of the page to delete. Cannot be used together with pageid.

pageid

Page ID of the page to delete. Cannot be used together with title.

Type: integer
reason

Reason for the deletion. If not set, an automatically generated reason will be used.

tags

Change tags to apply to the entry in the deletion log.

Values (separate with | or alternative):
watch
Deprecated.

Add the page to the current user's watchlist.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange
Default: preferences
unwatch
Deprecated.

Remove the page from the current user's watchlist.

Type: boolean (details)
oldimage

The name of the old image to delete as provided by action=query&prop=imageinfo&iiprop=archivename.

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=echomarkread

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: Echo
  • License: MIT

Mark notifications as read for the current user.

Parameters:
list

A list of notification IDs to mark as read.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
unreadlist

A list of notification IDs to mark as unread.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
all

If set, marks all of a user's notifications as read.

Type: boolean (details)
sections

A list of sections to mark as read.

Values (separate with | or alternative): alert, message
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=echomarkseen

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: Echo
  • License: MIT

Mark notifications as seen for the current user.

Parameters:
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
type

Type of notifications to mark as seen: 'alert', 'message' or 'all'.

This parameter is required.
One of the following values: alert, message, all
timestampFormat

Timestamp format to use for output, 'ISO_8601' or 'MW'. 'MW' is deprecated here, so all clients should switch to 'ISO_8601'. This parameter will be removed, and 'ISO_8601' will become the only output format.

One of the following values: ISO_8601, MW
Default: MW
Example:
Mark notifications of all types as seen
api.php?action=echomarkseen&type=all [open in sandbox]

action=edit

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Create and edit pages.

Parameters:
title

Title of the page to edit. Cannot be used together with pageid.

pageid

Page ID of the page to edit. Cannot be used together with title.

Type: integer
section

Section number. 0 for the top section, new for a new section.

sectiontitle

The title for a new section.

text

Page content.

summary

Edit summary. Also section title when section=new and sectiontitle is not set.

tags

Change tags to apply to the revision.

Values (separate with | or alternative):
minor

Minor edit.

Type: boolean (details)
notminor

Non-minor edit.

Type: boolean (details)
bot

Mark this edit as a bot edit.

Type: boolean (details)
basetimestamp

Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp.

Type: timestamp (allowed formats)
starttimestamp

Timestamp when the editing process began, used to detect edit conflicts. An appropriate value may be obtained using curtimestamp when beginning the edit process (e.g. when loading the page content to edit).

Type: timestamp (allowed formats)
recreate

Override any errors about the page having been deleted in the meantime.

Type: boolean (details)
createonly

Don't edit the page if it exists already.

Type: boolean (details)
nocreate

Throw an error if the page doesn't exist.

Type: boolean (details)
watch
Deprecated.

Add the page to the current user's watchlist.

Type: boolean (details)
unwatch
Deprecated.

Remove the page from the current user's watchlist.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange
Default: preferences
md5

The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.

prependtext

Add this text to the beginning of the page. Overrides text.

appendtext

Add this text to the end of the page. Overrides text.

Use section=new to append a new section, rather than this parameter.

undo

Undo this revision. Overrides text, prependtext and appendtext.

The value must be no less than 0.
Type: integer
undoafter

Undo all revisions from undo to this one. If not set, just undo one revision.

The value must be no less than 0.
Type: integer
redirect

Automatically resolve redirects.

Type: boolean (details)
contentformat

Content serialization format used for the input text.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
contentmodel

Content model of the new content.

One of the following values: Scribunto, GadgetDefinition, sanitized-css, wikitext, javascript, json, css, text, smw/schema, BSSocial, BSSocialProfile, BSSocialDiscussion
token

A "csrf" token retrieved from action=query&meta=tokens

The token should always be sent as the last parameter, or at least after the text parameter.

This parameter is required.

action=emailuser

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Email a user.

Parameters:
target

User to send email to.

This parameter is required.
subject

Subject header.

text

Mail body.

This parameter is required.
ccme

Send a copy of this mail to me.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
Example:
Send an email to user WikiSysop with the text Content.
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [open in sandbox]

action=embedvideo

  • This module requires read rights.
  • Source: EmbedVideo
  • License: MIT

Get generated embed code for given parameters

Parameters:
service

Name of the service (youtube, twitch, ect)

This parameter is required.
id

The ID of the video for that service

This parameter is required.
dimensions

Either a numeric width (100) or width by height (100x100)

alignment

Alignment of video

description

Description of video

container

Accepts frame, or leave empty

urlargs

Additional arguments to pass in the video url (for some services)

autoresize

Auto resize video? (true or false)

action=expandtemplates

Expands all templates within wikitext.

Parameters:
title

Title of page.

text

Wikitext to convert.

This parameter is required.
revid

Revision ID, for {{REVISIONID}} and similar variables.

Type: integer
prop

Which pieces of information to get.

Note that if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format.

wikitext
The expanded wikitext.
categories
Any categories present in the input that are not represented in the wikitext output.
properties
Page properties defined by expanded magic words in the wikitext.
volatile
Whether the output is volatile and should not be reused elsewhere within the page.
ttl
The maximum time after which caches of the result should be invalidated.
modules
Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
Gives the JavaScript configuration variables specific to the page.
encodedjsconfigvars
Gives the JavaScript configuration variables specific to the page as a JSON string.
parsetree
The XML parse tree of the input.
Values (separate with | or alternative): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree
includecomments

Whether to include HTML comments in the output.

Type: boolean (details)
generatexml
Deprecated.

Generate XML parse tree (replaced by prop=parsetree).

Type: boolean (details)
Example:
Expand the wikitext {{Project:Sandbox}}.
api.php?action=expandtemplates&text={{Project:Sandbox}} [open in sandbox]

action=ext.srf.slideshow.show

  • This module requires read rights.
  • Source: Semantic Result Formats
  • License: GPL-2.0-or-later

API module used by the SlideShow result printer to retrieve formatted results. This module is should not be called directly.

Parameters:
pageid

Id of the page (subject) to be displayed

This parameter is required.
Type: integer
template

Template to use for formatting

This parameter is required.
printouts

Printouts to send to the template

Default: []

action=feedcontributions

Returns a user contributions feed.

Parameters:
feedformat

The format of the feed.

One of the following values: rss, atom
Default: rss
user

What users to get the contributions for.

This parameter is required.
Type: user name
namespace

Which namespace to filter the contributions by.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
year

From year (and earlier).

Type: integer
month

From month (and earlier).

Type: integer
tagfilter

Filter contributions that have these tags.

Values (separate with | or alternative): mw-contentmodelchange, mw-new-redirect, mw-removed-redirect, mw-changed-redirect-target, mw-blank, mw-replace, mw-rollback, mw-undo, bs-checklist-change, visualeditor, visualeditor-needcheck, visualeditor-switched, visualeditor-wikitext
Default: (empty)
deletedonly

Show only deleted contributions.

Type: boolean (details)
toponly

Only show edits that are the latest revisions.

Type: boolean (details)
newonly

Only show edits that are page creations.

Type: boolean (details)
hideminor

Hide minor edits.

Type: boolean (details)
showsizediff

Show the size difference between revisions.

Type: boolean (details)
Example:
Return contributions for user Example.
api.php?action=feedcontributions&user=Example [open in sandbox]

action=feedrecentchanges

Returns a recent changes feed.

Parameters:
feedformat

The format of the feed.

One of the following values: rss, atom
Default: rss
namespace

Namespace to limit the results to.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
invert

All namespaces but the selected one.

Type: boolean (details)
associated

Include associated (talk or main) namespace.

Type: boolean (details)
days

Days to limit the results to.

The value must be no less than 1.
Type: integer
Default: 7
limit

Maximum number of results to return.

The value must be between 1 and 50.
Type: integer
Default: 50
from

Show changes since then.

Type: timestamp (allowed formats)
hideminor

Hide minor changes.

Type: boolean (details)
hidebots

Hide changes made by bots.

Type: boolean (details)
hideanons

Hide changes made by anonymous users.

Type: boolean (details)
hideliu

Hide changes made by registered users.

Type: boolean (details)
hidepatrolled

Hide patrolled changes.

Type: boolean (details)
hidemyself

Hide changes made by the current user.

Type: boolean (details)
hidecategorization

Hide category membership changes.

Type: boolean (details)
tagfilter

Filter by tag.

target

Show only changes on pages linked from this page.

showlinkedto

Show changes on pages linked to the selected page instead.

Type: boolean (details)

action=feedwatchlist

Returns a watchlist feed.

Parameters:
feedformat

The format of the feed.

One of the following values: rss, atom
Default: rss
hours

List pages modified within this many hours from now.

The value must be between 1 and 72.
Type: integer
Default: 24
linktosections

Link directly to changed sections if possible.

Type: boolean (details)
allrev

Include multiple revisions of the same page within given timeframe.

Type: boolean (details)
wlowner

Used along with token to access a different user's watchlist.

Type: user name
wltoken

A security token (available in the user's preferences) to allow access to another user's watchlist.

wlshow

Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.

Values (separate with | or alternative): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, autopatrolled, !autopatrolled, unread, !unread
wltype

Which types of changes to show:

edit
Regular page edits.
new
Page creations.
log
Log entries.
external
External changes.
categorize
Category membership changes.
Values (separate with | or alternative): edit, new, log, external, categorize
Default: edit|new|log|categorize
wlexcludeuser

Don't list changes by this user.

Type: user name
Examples:
Show the watchlist feed.
api.php?action=feedwatchlist [open in sandbox]
Show all changes to watched pages in the past 6 hours.
api.php?action=feedwatchlist&allrev=&hours=6 [open in sandbox]

action=filerevert

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Revert a file to an old version.

Parameters:
filename

Target filename, without the File: prefix.

This parameter is required.
comment

Upload comment.

Default: (empty)
archivename

Archive name of the revision to revert to.

This parameter is required.
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=flagconfig

  • This module requires read rights.
  • Source: Flagged Revisions
  • License: GPL-2.0-or-later

Get basic information about review flag configuration for this site.

The following parameters are returned for each tag:

name
The key name of this tag.
levels
Number of levels the tag has (above "not tagged").
tier2
Level the tag must reach for a revision to be tier 2 (quality).
tier3
Level the tag must reach for a revision to be tier 3 (pristine).

Flagged revisions have an assigned level for each tag. The highest tier that all the tags meet is the review tier of the entire revision.

Example:
Fetch flag configuration
api.php?action=flagconfig [open in sandbox]

action=geocode

API module for geocoding.

Parameter:
locations

The locations to geocode

This parameter is required.
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).

action=help

Display help for the specified modules.

Parameters:
modules

Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
Default: main
submodules

Include help for submodules of the named module.

Type: boolean (details)
recursivesubmodules

Include help for submodules recursively.

Type: boolean (details)
wrap

Wrap the output in a standard API response structure.

Type: boolean (details)
toc

Include a table of contents in the HTML output.

Type: boolean (details)

action=imagerotate

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Rotate one or more images.

Parameters:
rotation

Degrees to rotate image clockwise.

This parameter is required.
One of the following values: 90, 180, 270
continue

When more results are available, use this to continue.

tags

Tags to apply to the entry in the upload log.

Values (separate with | or alternative):
titles

A list of titles to work on.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks
Find all pages that link to the given page.
categories
List all categories the pages belong to.
categorymembers
List all pages in a given category.
configuredpages
Enumerate all pages that have custom review configurations.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
fileusage
Find all pages that use the given files.
images
Returns all files contained on the given pages.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
oldreviewedpages
Enumerates pages that have changes pending review.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
redirects
Returns all redirects to the given pages.
reviewedpages
Enumerates pages that have a reviewed version.
revisions
Get revision information.
search
Perform a full text search.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
unreviewedpages
Enumerates pages that have not been reviewed to a given quality level.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, configuredpages, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, oldreviewedpages, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, reviewedpages, revisions, search, templates, transcludedin, unreviewedpages, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=import

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

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

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the xml parameter.

Parameters:
summary

Log entry import summary.

xml

Uploaded XML file.

Must be posted as a file upload using multipart/form-data.
interwikiprefix

For uploaded imports: interwiki prefix to apply to unknown user names (and known users if assignknownusers is set).

interwikisource

For interwiki imports: wiki to import from.

One of the following values:
interwikipage

For interwiki imports: page to import.

fullhistory

For interwiki imports: import the full history, not just the current version.

Type: boolean (details)
templates

For interwiki imports: import all included templates as well.

Type: boolean (details)
namespace

Import to this namespace. Cannot be used together with rootpage.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
assignknownusers

Assign edits to local users where the named user exists locally.

Type: boolean (details)
rootpage

Import as subpage of this page. Cannot be used together with namespace.

tags

Change tags to apply to the entry in the import log and to the null revision on the imported pages.

Values (separate with | or alternative):
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=linkaccount (link)

  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Link an account from a third-party provider to the current user.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=link, and a csrf token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying linkreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with linkcontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to linkreturnurl. Then post to this module with linkcontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
Parameters:
linkrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=link or from a previous response from this module.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
linkmessageformat

Format to use for returning messages.

One of the following values: html, wikitext, raw, none
Default: wikitext
linkmergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)
linkreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or linkcontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a linkcontinue request to this API module.

linkcontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or linkreturnurl is required.

Type: boolean (details)
linktoken

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=link (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

action=login (lg)

  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Log in and get authentication cookies.

This action should only be used in combination with Special:BotPasswords; use for main-account login is deprecated and may fail without warning. To safely log in to the main account, use action=clientlogin.

Parameters:
lgname

User name.

lgpassword

Password.

lgdomain

Domain (optional).

lgtoken

A "login" token retrieved from action=query&meta=tokens

action=logout

  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Log out and clear session data.

Parameter:
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
Example:
Log the current user out.
api.php?action=logout&token=123ABC [open in sandbox]

action=managetags

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Perform management tasks relating to change tags.

Parameters:
operation

Which operation to perform:

create
Create a new change tag for manual use.
delete
Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used.
activate
Activate a change tag, allowing users to apply it manually.
deactivate
Deactivate a change tag, preventing users from applying it manually.
This parameter is required.
One of the following values: create, delete, activate, deactivate
tag

Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.

This parameter is required.
reason

An optional reason for creating, deleting, activating or deactivating the tag.

ignorewarnings

Whether to ignore any warnings that are issued during the operation.

Type: boolean (details)
tags

Change tags to apply to the entry in the tag management log.

Values (separate with | or alternative):
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=mergehistory

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Merge page histories.

Parameters:
from

Title of the page from which history will be merged. Cannot be used together with fromid.

fromid

Page ID of the page from which history will be merged. Cannot be used together with from.

Type: integer
to

Title of the page to which history will be merged. Cannot be used together with toid.

toid

Page ID of the page to which history will be merged. Cannot be used together with to.

Type: integer
timestamp

Timestamp up to which revisions will be moved from the source page's history to the destination page's history. If omitted, the entire page history of the source page will be merged into the destination page.

Type: timestamp (allowed formats)
reason

Reason for the history merge.

Default: (empty)
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=move

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Move a page.

Parameters:
from

Title of the page to rename. Cannot be used together with fromid.

fromid

Page ID of the page to rename. Cannot be used together with from.

Type: integer
to

Title to rename the page to.

This parameter is required.
reason

Reason for the rename.

Default: (empty)
movetalk

Rename the talk page, if it exists.

Type: boolean (details)
movesubpages

Rename subpages, if applicable.

Type: boolean (details)
noredirect

Don't create a redirect.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange
Default: preferences
ignorewarnings

Ignore any warnings.

Type: boolean (details)
tags

Change tags to apply to the entry in the move log and to the null revision on the destination page.

Values (separate with | or alternative):
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=opensearch

Search the wiki using the OpenSearch protocol.

Parameters:
search

Search string.

This parameter is required.
namespace

Namespaces to search. Ignored if search begins with a valid namespace prefix.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
Default: 0
limit

Maximum number of results to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
suggest

Do nothing if $wgEnableOpenSearchSuggest is false.

Type: boolean (details)
redirects

How to handle redirects:

return
Return the redirect itself.
resolve
Return the target page. May return fewer than limit results.

For historical reasons, the default is "return" for format=json and "resolve" for other formats.

One of the following values: return, resolve
format

The format of the output.

One of the following values: json, jsonfm, xml, xmlfm
Default: json
warningsaserror

If warnings are raised with format=json, return an API error instead of ignoring them.

Type: boolean (details)
Example:
Find pages beginning with Te.
api.php?action=opensearch&search=Te [open in sandbox]

action=options

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Change preferences of the current user.

Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs- (intended to be used by user scripts), can be set.

Parameters:
reset

Resets preferences to the site defaults.

Type: boolean (details)
resetkinds

List of types of options to reset when the reset option is set.

Values (separate with | or alternative): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all
Default: all
change

List of changes, formatted name=value (e.g. skin=vector). If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value. If any value passed contains the pipe character (|), use the alternative multiple-value separator for correct operation.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
optionname

The name of the option that should be set to the value given by optionvalue.

optionvalue

The value for the option specified by optionname.

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=paraminfo

Obtain information about API modules.

Parameters:
modules

List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
helpformat

Format of help strings.

One of the following values: html, wikitext, raw, none
Default: none
querymodules
Deprecated.

List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.

Values (separate with | or alternative): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, backlinks, blocks, bsbookshelf, categories, categoryinfo, categorymembers, configuredpages, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, extracts, exturlusage, filearchive, filerepoinfo, fileusage, flagged, gadgetcategories, gadgets, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, links, linkshere, logevents, mystashedfiles, notifications, oldreviewedpages, pageimages, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, references, reviewedpages, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, unreadnotificationpages, unreviewedpages, usercontribs, userinfo, users, watchlist, watchlistraw
Maximum number of values is 50 (500 for bots).
mainmodule
Deprecated.

Get information about the main (top-level) module as well. Use modules=main instead.

pagesetmodule
Deprecated.

Get information about the pageset module (providing titles= and friends) as well.

formatmodules
Deprecated.

List of format module names (value of format parameter). Use modules instead.

Values (separate with | or alternative): json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm

action=parse

Parses content and returns parser output.

See the various prop-modules of action=query to get information from the current version of a page.

There are several ways to specify the text to parse:

  1. Specify a page or revision, using page, pageid, or oldid.
  2. Specify content explicitly, using text, title, revid, and contentmodel.
  3. Specify only a summary to parse. prop should be given an empty value.
Parameters:
title

Title of page the text belongs to. If omitted, contentmodel must be specified, and API will be used as the title.

text

Text to parse. Use title or contentmodel to control the content model.

revid

Revision ID, for {{REVISIONID}} and similar variables.

Type: integer
summary

Summary to parse.

page

Parse the content of this page. Cannot be used together with text and title.

pageid

Parse the content of this page. Overrides page.

Type: integer
redirects

If page or pageid is set to a redirect, resolve it.

Type: boolean (details)
oldid

Parse the content of this revision. Overrides page and pageid.

Type: integer
prop

Which pieces of information to get:

text
Gives the parsed text of the wikitext.
langlinks
Gives the language links in the parsed wikitext.
categories
Gives the categories in the parsed wikitext.
categorieshtml
Gives the HTML version of the categories.
links
Gives the internal links in the parsed wikitext.
templates
Gives the templates in the parsed wikitext.
images
Gives the images in the parsed wikitext.
externallinks
Gives the external links in the parsed wikitext.
sections
Gives the sections in the parsed wikitext.
revid
Adds the revision ID of the parsed page.
displaytitle
Adds the title of the parsed wikitext.
headhtml
Gives parsed <head> of the page.
modules
Gives the ResourceLoader modules used on the page. To load, use mw.loader.using(). Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
jsconfigvars
Gives the JavaScript configuration variables specific to the page. To apply, use mw.config.set().
encodedjsconfigvars
Gives the JavaScript configuration variables specific to the page as a JSON string.
indicators
Gives the HTML of page status indicators used on the page.
iwlinks
Gives interwiki links in the parsed wikitext.
wikitext
Gives the original wikitext that was parsed.
properties
Gives various properties defined in the parsed wikitext.
limitreportdata
Gives the limit report in a structured way. Gives no data, when disablelimitreport is set.
limitreporthtml
Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set.
parsetree
The XML parse tree of revision content (requires content model wikitext)
parsewarnings
Gives the warnings that occurred while parsing content.
headitems
Deprecated. Gives items to put in the <head> of the page.
Values (separate with | or alternative): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree, parsewarnings, headitems
Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
wrapoutputclass

CSS class to use to wrap the parser output.

Default: mw-parser-output
pst

Do a pre-save transform on the input before parsing it. Only valid when used with text.

Type: boolean (details)
onlypst

Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.

Type: boolean (details)
effectivelanglinks
Deprecated.

Includes language links supplied by extensions (for use with prop=langlinks).

Type: boolean (details)
section

Only parse the content of this section number.

When new, parse text and sectiontitle as if adding a new section to the page.

new is allowed only when specifying text.

sectiontitle

New section title when section is new.

Unlike page editing, this does not fall back to summary when omitted or empty.

disablepp
Deprecated.

Use disablelimitreport instead.

Type: boolean (details)
disablelimitreport

Omit the limit report ("NewPP limit report") from the parser output.

Type: boolean (details)
disableeditsection

Omit edit section links from the parser output.

Type: boolean (details)
disabletidy

Do not run HTML cleanup (e.g. tidy) on the parser output.

Type: boolean (details)
disablestylededuplication

Do not deduplicate inline stylesheets in the parser output.

Type: boolean (details)
generatexml
Deprecated.

Generate XML parse tree (requires content model wikitext; replaced by prop=parsetree).

Type: boolean (details)
preview

Parse in preview mode.

Type: boolean (details)
sectionpreview

Parse in section preview mode (enables preview mode too).

Type: boolean (details)
disabletoc

Omit table of contents in output.

Type: boolean (details)
useskin

Apply the selected skin to the parser output. May affect the following properties: langlinks, headitems, modules, jsconfigvars, indicators.

One of the following values: bluespicecalumma
contentformat

Content serialization format used for the input text. Only valid when used with text.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
contentmodel

Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.

One of the following values: Scribunto, GadgetDefinition, sanitized-css, wikitext, javascript, json, css, text, smw/schema, BSSocial, BSSocialProfile, BSSocialDiscussion

action=patrol

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Patrol a page or revision.

Parameters:
rcid

Recentchanges ID to patrol.

Type: integer
revid

Revision ID to patrol.

Type: integer
tags

Change tags to apply to the entry in the patrol log.

Values (separate with | or alternative):
token

A "patrol" token retrieved from action=query&meta=tokens

This parameter is required.

action=pfautocomplete

Autocompletion used by the Page Forms extension.

Parameters:
limit

A limit on the number of results returned

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
substr

The substring to autocomplete on

property

A Semantic MediaWiki property whose values will be autocompleted on

category

A category whose pages will be autocompleted on

concept

A Semantic MediaWiki "concept" whose pages will be autocompleted on

cargo_table

A database table, defined by the Cargo extension, whose values will be autocompleted on

cargo_field

The field of the Cargo table whose values will be autocompleted on

namespace

A namespace whose pages will be autocompleted on

external_url

An alias for an external URL from which to get values

baseprop

A previous Semantic MediaWiki property in the form to check against

base_cargo_table

The Cargo table for a previous field in the form to check against

base_cargo_field

The Cargo field for a previous field in the form to check against

basevalue

The value to check for the previous property or field

action=pfautoedit

  • This module requires read rights.
  • This module requires write rights.
  • Source: PageForms
  • License: GPL-2.0-or-later

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

Parameters:
form

The Page Forms form to use

target

The name of the page to be created or edited

query

The query string

preload

The name of a page to preload in the form

Example:
With query parameter: api.php?action=pfautoedit&form=form-name&target=page-name&query=template-name[field-name-1]=field-value-1%26template-name[field-name-2]=field-value-2
api.php?Without query parameter: api.php?action=pfautoedit&form=form-name&target=page-name&template-name[field-name-1]=field-value-1&template-name[field-name-2]=field-value-2 [open in sandbox]

action=protect

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Change the protection level of a page.

Parameters:
title

Title of the page to (un)protect. Cannot be used together with pageid.

pageid

ID of the page to (un)protect. Cannot be used together with title.

Type: integer
protections

List of protection levels, formatted action=level (e.g. edit=sysop). A level of all means everyone is allowed to take the action, i.e. no restriction.

Note: Any actions not listed will have restrictions removed.

This parameter is required.
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
expiry

Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
Default: infinite
reason

Reason for (un)protecting.

Default: (empty)
tags

Change tags to apply to the entry in the protection log.

Values (separate with | or alternative):
cascade

Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.

Type: boolean (details)
watch
Deprecated.

If set, add the page being (un)protected to the current user's watchlist.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange
Default: preferences
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

action=purge

  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Purge the cache for the given titles.

Parameters:
forcelinkupdate

Update the links tables.

Type: boolean (details)
forcerecursivelinkupdate

Update the links table, and update the links tables for any page that uses this page as a template.

Type: boolean (details)
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks
Find all pages that link to the given page.
categories
List all categories the pages belong to.
categorymembers
List all pages in a given category.
configuredpages
Enumerate all pages that have custom review configurations.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
fileusage
Find all pages that use the given files.
images
Returns all files contained on the given pages.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
oldreviewedpages
Enumerates pages that have changes pending review.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
redirects
Returns all redirects to the given pages.
reviewedpages
Enumerates pages that have a reviewed version.
revisions
Get revision information.
search
Perform a full text search.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
unreviewedpages
Enumerates pages that have not been reviewed to a given quality level.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, configuredpages, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, oldreviewedpages, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, reviewedpages, revisions, search, templates, transcludedin, unreviewedpages, watchlist, watchlistraw
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.

Type: boolean (details)
Examples:
Purge the Main Page and the API page.
api.php?action=purge&titles=Main_Page|API [open in sandbox]
Purge the first 10 pages in the main namespace.
api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [open in sandbox]

action=query

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

Parameters:
prop

Which properties to get for the queried pages.

categories
List all categories the pages belong to.
categoryinfo
Returns information about the given categories.
contributors
Get the list of logged-in contributors and the count of anonymous contributors to a page.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
extlinks
Returns all external URLs (not interwikis) from the given pages.
extracts
Returns plain-text or limited HTML extracts of the given pages.
fileusage
Find all pages that use the given files.
flagged
Get information about the flagging status of the given pages.
imageinfo
Returns file information and upload history.
images
Returns all files contained on the given pages.
info
Get basic page information.
iwlinks
Returns all interwiki links from the given pages.
langlinks
Returns all interlanguage links from the given pages.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
pageimages
Returns information about images on the page, such as thumbnail and presence of photos.
pageprops
Get various page properties defined in the page content.
redirects
Returns all redirects to the given pages.
references
Return a data representation of references associated with the given pages.
revisions
Get revision information.
stashimageinfo
Returns file information for stashed files.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
Values (separate with | or alternative): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, extracts, fileusage, flagged, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageimages, pageprops, redirects, references, revisions, stashimageinfo, templates, transcludedin
list

Which lists to get.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
allusers
Enumerate all registered users.
backlinks
Find all pages that link to the given page.
blocks
List all blocked users and IP addresses.
bsbookshelf
Allows querying in all books.
categorymembers
List all pages in a given category.
configuredpages
Enumerate all pages that have custom review configurations.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
filearchive
Enumerate all deleted files sequentially.
gadgetcategories
Returns a list of gadget categories.
gadgets
Returns a list of gadgets used on this wiki.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
logevents
Get events from logs.
mystashedfiles
Get a list of files in the current user's upload stash.
oldreviewedpages
Enumerates pages that have changes pending review.
pagepropnames
List all page property names in use on the wiki.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
reviewedpages
Enumerates pages that have a reviewed version.
search
Perform a full text search.
tags
List change tags.
unreviewedpages
Enumerates pages that have not been reviewed to a given quality level.
usercontribs
Get all edits by a user.
users
Get information about a list of users.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
deletedrevs
Deprecated. List deleted revisions.
Values (separate with | or alternative): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, bsbookshelf, categorymembers, configuredpages, embeddedin, exturlusage, filearchive, gadgetcategories, gadgets, imageusage, iwbacklinks, langbacklinks, logevents, mystashedfiles, oldreviewedpages, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, reviewedpages, search, tags, unreviewedpages, usercontribs, users, watchlist, watchlistraw, deletedrevs
meta

Which metadata to get.

allmessages
Return messages from this site.
authmanagerinfo
Retrieve information about the current authentication status.
filerepoinfo
Return meta information about image repositories configured on the wiki.
notifications
Get notifications waiting for the current user.
siteinfo
Return general information about the site.
tokens
Gets tokens for data-modifying actions.
unreadnotificationpages
Get pages for which there are unread notifications for the current user.
userinfo
Get information about the current user.
Values (separate with | or alternative): allmessages, authmanagerinfo, filerepoinfo, notifications, siteinfo, tokens, unreadnotificationpages, userinfo
indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)
export

Export the current revisions of all given or generated pages.

Type: boolean (details)
exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with query+export.

Type: boolean (details)
iwurl

Whether to get the full URL if the title is an interwiki link.

Type: boolean (details)
continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)
titles

A list of titles to work on.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks
Find all pages that link to the given page.
categories
List all categories the pages belong to.
categorymembers
List all pages in a given category.
configuredpages
Enumerate all pages that have custom review configurations.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
fileusage
Find all pages that use the given files.
images
Returns all files contained on the given pages.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
oldreviewedpages
Enumerates pages that have changes pending review.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
redirects
Returns all redirects to the given pages.
reviewedpages
Enumerates pages that have a reviewed version.
revisions
Get revision information.
search
Perform a full text search.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
unreviewedpages
Enumerates pages that have not been reviewed to a given quality level.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, configuredpages, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, oldreviewedpages, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, reviewedpages, revisions, search, templates, transcludedin, unreviewedpages, watchlist, watchlistraw
redirects

Automatically resolve redirects in query+titles, query+pageids, and query+revids, and in pages returned by query+generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.

Type: boolean (details)

prop=categories (cl)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all categories the pages belong to.

Parameters:
clprop

Which additional properties to get for each category:

sortkey
Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category.
timestamp
Adds timestamp of when the category was added.
hidden
Tags categories that are hidden with __HIDDENCAT__.
Values (separate with | or alternative): sortkey, timestamp, hidden
clshow

Which kind of categories to show.

Values (separate with | or alternative): hidden, !hidden
cllimit

How many categories to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
clcontinue

When more results are available, use this to continue.

clcategories

Only list these categories. Useful for checking whether a certain page is in a certain category.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
cldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
Examples:
Get a list of categories the page Albert Einstein belongs to.
api.php?action=query&prop=categories&titles=Albert%20Einstein [open in sandbox]
Get information about all categories used in the page Albert Einstein.
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [open in sandbox]

prop=categoryinfo (ci)

Returns information about the given categories.

Parameter:
cicontinue

When more results are available, use this to continue.

Example:
Get information about Category:Foo and Category:Bar.
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [open in sandbox]

prop=contributors (pc)

Get the list of logged-in contributors and the count of anonymous contributors to a page.

Parameters:
pcgroup

Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): bot, sysop, bureaucrat, widgeteditor, editor, reviewer, autoreview, visitor, Book_publisher, smwadministrator, smwcurator
pcexcludegroup

Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): bot, sysop, bureaucrat, widgeteditor, editor, reviewer, autoreview, visitor, Book_publisher, smwadministrator, smwcurator
pcrights

Only include users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, dpl_param_update_rules, dpl_param_delete_rules, usermerge, replacetext, gadgets-edit, gadgets-definition-edit, nuke, renameuser, wikiadmin, editor, bluespiceabout-viewspecialpage, bookshelfbookmanager-viewspecialpage, bookshelfbookui-viewspecialpage, checklistmodify, bluespiceconfigmanager-viewspecialpage, dashboards-viewspecialpage-userdashboard, extendedsearch-search-specialpage, extendedsearch-search-wikipage, extendedsearch-search-repofile, extendedsearch-search-externalfile, statistic-viewspecialpage, groupmanager-viewspecialpage, interwikilinks-viewspecialpage, namespacemanager-viewspecialpage, pageaccess-viewspecialpage, pageassignable, pageassignments, pagetemplatesadmin-viewspecialpage, permissionmanager-viewspecialpage, bs-privacy-admin, rssfeeder-viewspecialpage, viewreaders, uemodulebookpdf-export, uemodulepdf-export, uemodulepdfrecursive-export, uemodulepdfsubpages-export, usagetracker-update, usermanager-viewspecialpage, viewedittab, editrestrictedfields, createclass, multipageedit, categorymanager-viewspecialpage, rating-read, rating-write, rating-archive, rating-viewspecialpage, readconfirmationremind, remindereditall, expirearticle, generatepages, workflowview, workflowedit, workflowlist, social-deleteothers, social-editothers, social-source, social-editothersprofile, socialprofile-viewspecialpage, social-tagging, duplicate, editwidgets, review, validate, autoreview, autoreviewrestore, unreviewedpages, movestable, stablesettings, smw-admin, smw-patternedit, smw-schemaedit, smw-pageedit, geocode
Maximum number of values is 50 (500 for bots).
pcexcluderights

Exclude users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, dpl_param_update_rules, dpl_param_delete_rules, usermerge, replacetext, gadgets-edit, gadgets-definition-edit, nuke, renameuser, wikiadmin, editor, bluespiceabout-viewspecialpage, bookshelfbookmanager-viewspecialpage, bookshelfbookui-viewspecialpage, checklistmodify, bluespiceconfigmanager-viewspecialpage, dashboards-viewspecialpage-userdashboard, extendedsearch-search-specialpage, extendedsearch-search-wikipage, extendedsearch-search-repofile, extendedsearch-search-externalfile, statistic-viewspecialpage, groupmanager-viewspecialpage, interwikilinks-viewspecialpage, namespacemanager-viewspecialpage, pageaccess-viewspecialpage, pageassignable, pageassignments, pagetemplatesadmin-viewspecialpage, permissionmanager-viewspecialpage, bs-privacy-admin, rssfeeder-viewspecialpage, viewreaders, uemodulebookpdf-export, uemodulepdf-export, uemodulepdfrecursive-export, uemodulepdfsubpages-export, usagetracker-update, usermanager-viewspecialpage, viewedittab, editrestrictedfields, createclass, multipageedit, categorymanager-viewspecialpage, rating-read, rating-write, rating-archive, rating-viewspecialpage, readconfirmationremind, remindereditall, expirearticle, generatepages, workflowview, workflowedit, workflowlist, social-deleteothers, social-editothers, social-source, social-editothersprofile, socialprofile-viewspecialpage, social-tagging, duplicate, editwidgets, review, validate, autoreview, autoreviewrestore, unreviewedpages, movestable, stablesettings, smw-admin, smw-patternedit, smw-schemaedit, smw-pageedit, geocode
Maximum number of values is 50 (500 for bots).
pclimit

How many contributors to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
pccontinue

When more results are available, use this to continue.

Example:
Show contributors to the page Main Page.
api.php?action=query&prop=contributors&titles=Main_Page [open in sandbox]

prop=deletedrevisions (drv)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Get deleted revision information.

May be used in several ways:

  1. Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
  2. Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
Parameters:
drvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Default: ids|timestamp|flags|comment|user
drvlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
drvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires drvprop=content).

Type: boolean (details)
drvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires drvprop=content).

Type: boolean (details)
drvparse
Deprecated.

Use action=parse instead. Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.

Type: boolean (details)
drvsection

Only retrieve the content of this section number.

drvdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

drvdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text.

drvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.

Type: boolean (details)
drvcontentformat

Serialization format used for drvdifftotext and expected for output of content.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
drvstart

The timestamp to start enumerating from. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)
drvend

The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)
drvdir

In which direction to enumerate:

newer
List oldest first. Note: drvstart has to be before drvend.
older
List newest first (default). Note: drvstart has to be later than drvend.
One of the following values: newer, older
Default: older
drvtag

Only list revisions tagged with this tag.

drvuser

Only list revisions by this user.

Type: user name
drvexcludeuser

Don't list revisions by this user.

Type: user name
drvcontinue

When more results are available, use this to continue.

Examples:
List the deleted revisions of the pages Main Page and Talk:Main Page, with content.
api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content [open in sandbox]
List the information for deleted revision 123456.
api.php?action=query&prop=deletedrevisions&revids=123456 [open in sandbox]

prop=duplicatefiles (df)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all files that are duplicates of the given files based on hash values.

Parameters:
dflimit

How many duplicate files to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
dfcontinue

When more results are available, use this to continue.

dfdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
dflocalonly

Look only for files in the local repository.

Type: boolean (details)

Returns all external URLs (not interwikis) from the given pages.

Parameters:
ellimit

How many links to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
eloffset

When more results are available, use this to continue.

Type: integer
elprotocol

Protocol of the URL. If empty and elquery is set, the protocol is http. Leave both this and elquery empty to list all external links.

One of the following values: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp, file, file
Default: (empty)
elquery

Search string without protocol. Useful for checking whether a certain page contains a certain external url.

elexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)
Example:
Get a list of external links on Main Page.
api.php?action=query&prop=extlinks&titles=Main%20Page [open in sandbox]

prop=extracts (ex)

Returns plain-text or limited HTML extracts of the given pages.

Parameters:
exchars

How many characters to return. Actual text returned might be slightly longer.

The value must be between 1 and 1,200.
Type: integer
exsentences

How many sentences to return.

The value must be between 1 and 10.
Type: integer
exlimit

How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)

No more than 20 (20 for bots) allowed.
Type: integer or max
Default: 20
exintro

Return only content before the first section.

Type: boolean (details)
explaintext

Return extracts as plain text instead of limited HTML.

Type: boolean (details)
exsectionformat

How to format sections in plaintext mode:

plain
No formatting.
wiki
Wikitext-style formatting (== like this ==).
raw
This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>).
One of the following values: plain, wiki, raw
Default: wiki
excontinue

When more results are available, use this to continue.

Type: integer

prop=fileusage (fu)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that use the given files.

Parameters:
fuprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
Values (separate with | or alternative): pageid, title, redirect
Default: pageid|title|redirect
funamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
fushow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Values (separate with | or alternative): redirect, !redirect
fulimit

How many to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
fucontinue

When more results are available, use this to continue.

prop=flagged

  • This module requires read rights.
  • Source: Flagged Revisions
  • License: GPL-2.0-or-later

Get information about the flagging status of the given pages.

If a page is flagged, the following parameters are returned:

stable_revid
The revision ID of the latest stable revision.
level
level_text
The highest flagging level of the page.
pending_since
If there are any current unreviewed revisions for that page, holds the timestamp of the first of them.

If the page has protection configuration, the following parameters are returned:

protection_level
The right a user must have to not require review on the page.
protection_expiry
When the protection expires.

prop=imageinfo (ii)

Returns file information and upload history.

Parameters:
iiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename
Adds the filename of the archive version for non-latest versions.
bitdepth
Adds the bit depth of the version.
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
badfile
Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning, badfile
Default: timestamp|user
iilimit

How many file revisions to return per file.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 1
iistart

Timestamp to start listing from.

Type: timestamp (allowed formats)
iiend

Timestamp to stop listing at.

Type: timestamp (allowed formats)
iiurlwidth

If iiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer
Default: -1
iiurlheight

Similar to iiurlwidth.

Type: integer
Default: -1
iimetadataversion

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

Default: 1
iiextmetadatalanguage

What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.

Default: en
iiextmetadatamultilang

If translations for extmetadata property are available, fetch all of them.

Type: boolean (details)
iiextmetadatafilter

If specified and non-empty, only these keys will be returned for iiprop=extmetadata.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
iiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.

Default: (empty)
iibadfilecontexttitle

If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list

iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)

prop=images (im)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Returns all files contained on the given pages.

Parameters:
imlimit

How many files to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
imcontinue

When more results are available, use this to continue.

imimages

Only list these files. Useful for checking whether a certain page has a certain file.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
imdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

prop=info (in)

Get basic page information.

Parameters:
inprop

Which additional properties to get:

protection
List the protection level of each page.
talkid
The page ID of the talk page for each non-talk page.
watched
List the watched status of each page.
watchers
The number of watchers, if allowed.
visitingwatchers
The number of watchers of each page who have visited recent edits to that page, if allowed.
notificationtimestamp
The watchlist notification timestamp of each page.
subjectid
The page ID of the parent page for each talk page.
url
Gives a full URL, an edit URL, and the canonical URL for each page.
readable
Whether the user can read this page.
preload
Gives the text returned by EditFormPreloadText.
displaytitle
Gives the manner in which the page title is actually displayed.
varianttitles
Gives the display title in all variants of the site content language.
Values (separate with | or alternative): protection, talkid, watched, watchers, visitingwatchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle, varianttitles
intestactions

Test whether the current user can perform certain actions on the page.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
intoken
Deprecated.

Use action=query&meta=tokens instead.

Values (separate with | or alternative): edit, delete, protect, move, block, unblock, email, import, watch
incontinue

When more results are available, use this to continue.

Examples:
Get information about the page Main Page.
api.php?action=query&prop=info&titles=Main%20Page [open in sandbox]
Get general and protection information about the page Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [open in sandbox]

Returns all interwiki links from the given pages.

Parameters:
iwprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
Values (separate with | or alternative): url
iwprefix

Only return interwiki links with this prefix.

iwtitle

Interwiki link to search for. Must be used with iwprefix.

iwdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
iwlimit

How many interwiki links to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
iwcontinue

When more results are available, use this to continue.

iwurl
Deprecated.

Whether to get the full URL (cannot be used with iwprop).

Type: boolean (details)
Example:
Get interwiki links from the page Main Page.
api.php?action=query&prop=iwlinks&titles=Main%20Page [open in sandbox]

Returns all interlanguage links from the given pages.

Parameters:
llprop

Which additional properties to get for each interlanguage link:

url
Adds the full URL.
langname
Adds the localised language name (best effort). Use llinlanguagecode to control the language.
autonym
Adds the native language name.
Values (separate with | or alternative): url, langname, autonym
lllang

Only return language links with this language code.

lltitle

Link to search for. Must be used with lllang.

lldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
llinlanguagecode

Language code for localised language names.

Default: en
lllimit

How many langlinks to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
llcontinue

When more results are available, use this to continue.

llurl
Deprecated.

Whether to get the full URL (cannot be used with llprop).

Type: boolean (details)
Example:
Get interlanguage links from the page Main Page.
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [open in sandbox]
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Returns all links from the given pages.

Parameters:
plnamespace

Show links in these namespaces only.

Values (separate with | or alternative): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
pllimit

How many links to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
plcontinue

When more results are available, use this to continue.

pltitles

Only list links to these titles. Useful for checking whether a certain page links to a certain title.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
pldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
Examples:
Get links from the page Main Page
api.php?action=query&prop=links&titles=Main%20Page [open in sandbox]
Get information about the link pages in the page Main Page.
api.php?action=query&generator=links&titles=Main%20Page&prop=info [open in sandbox]
Get links from the page Main Page in the User and Template namespaces.
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [open in sandbox]

prop=linkshere (lh)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that link to the given pages.

Parameters:
lhprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
Values (separate with | or alternative): pageid, title, redirect
Default: pageid|title|redirect
lhnamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
lhshow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Values (separate with | or alternative): redirect, !redirect
lhlimit

How many to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
lhcontinue

When more results are available, use this to continue.

prop=pageimages (pi)

  • This module requires read rights.
  • Source: PageImages
  • License: WTFPL

Returns information about images on the page, such as thumbnail and presence of photos.

Parameters:
piprop

Which information to return:

thumbnail
URL and dimensions of thumbnail image associated with page, if any.
original
URL and original dimensions of image associated with page, if any.
name
Image title.
Values (separate with | or alternative): thumbnail, name, original
Default: thumbnail|name
pithumbsize

Maximum width in pixels of thumbnail images.

Type: integer
Default: 50
pilimit

Properties of how many pages to return.

No more than 50 (100 for bots) allowed.
Type: integer or max
Default: 50
pilicense

Limit page images to a certain license type

One of the following values: free, any
Default: free
picontinue

When more results are available, use this to continue.

Type: integer
Example:
Get name and 100-pixel thumbnail of an image on the Albert Einstein page.
api.php?action=query&prop=pageimages&titles=Albert%20Einstein&pithumbsize=100 [open in sandbox]

prop=pageprops (pp)

Get various page properties defined in the page content.

Parameters:
ppcontinue

When more results are available, use this to continue.

ppprop

Only list these page properties (action=query&list=pagepropnames returns page property names in use). Useful for checking whether pages use a certain page property.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
Example:
Get properties for the pages Main Page and MediaWiki.
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [open in sandbox]

prop=redirects (rd)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Returns all redirects to the given pages.

Parameters:
rdprop

Which properties to get:

pageid
Page ID of each redirect.
title
Title of each redirect.
fragment
Fragment of each redirect, if any.
Values (separate with | or alternative): pageid, title, fragment
Default: pageid|title
rdnamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
rdshow

Show only items that meet these criteria:

fragment
Only show redirects with a fragment.
!fragment
Only show redirects without a fragment.
Values (separate with | or alternative): fragment, !fragment
rdlimit

How many redirects to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
rdcontinue

When more results are available, use this to continue.

prop=references (rf)

Return a data representation of references associated with the given pages.

Parameter:
rfcontinue

When more results are available, use this to continue.

Example:
References associated with Albert Einstein.
api.php?action=query&prop=references&titles=Albert%20Einstein [open in sandbox]

prop=revisions (rv)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Get revision information.

May be used in several ways:

  1. Get data about a set of pages (last revision), by setting titles or pageids.
  2. Get revisions for one given page, by using titles or pageids with start, end, or limit.
  3. Get data about a set of revisions by setting their IDs with revids.
Parameters:
rvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
flagged
Flagged status of the revision.
Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree, flagged
Default: ids|timestamp|flags|comment|user
rvlimit

Limit how many revisions will be returned.

May only be used with a single page (mode #2).
No more than 500 (5,000 for bots) allowed.
Type: integer or max
rvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires rvprop=content).

Type: boolean (details)
rvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires rvprop=content).

Type: boolean (details)
rvparse
Deprecated.

Use action=parse instead. Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.

Type: boolean (details)
rvsection

Only retrieve the content of this section number.

rvdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

rvdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.

rvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.

Type: boolean (details)
rvcontentformat

Serialization format used for rvdifftotext and expected for output of content.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
rvstartid

Start enumeration from this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
Type: integer
rvendid

Stop enumeration at this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
Type: integer
rvstart

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvend

Enumerate up to this timestamp.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvdir

In which direction to enumerate:

newer
List oldest first. Note: rvstart has to be before rvend.
older
List newest first (default). Note: rvstart has to be later than rvend.
May only be used with a single page (mode #2).
One of the following values: newer, older
Default: older
rvuser

Only include revisions made by user.

May only be used with a single page (mode #2).
Type: user name
rvexcludeuser

Exclude revisions made by user.

May only be used with a single page (mode #2).
Type: user name
rvtag

Only list revisions tagged with this tag.

rvtoken
Deprecated.

Which tokens to obtain for each revision.

Values (separate with | or alternative): rollback
rvcontinue

When more results are available, use this to continue.

prop=stashimageinfo (sii)

Returns file information for stashed files.

Parameters:
siifilekey

Key that identifies a previous upload that was stashed temporarily.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
siisessionkey
Deprecated.

Alias for siifilekey, for backward compatibility.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
siiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param siiurlwidth).
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
badfile
Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): timestamp, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, metadata, commonmetadata, extmetadata, bitdepth, badfile
Default: timestamp|url
siiurlwidth

If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer
Default: -1
siiurlheight

Similar to siiurlwidth.

Type: integer
Default: -1
siiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.

Default: (empty)

prop=templates (tl)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Returns all pages transcluded on the given pages.

Parameters:
tlnamespace

Show templates in these namespaces only.

Values (separate with | or alternative): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
tllimit

How many templates to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
tlcontinue

When more results are available, use this to continue.

tltemplates

Only list these templates. Useful for checking whether a certain page uses a certain template.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
tldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
Examples:
Get the templates used on the page Main Page.
api.php?action=query&prop=templates&titles=Main%20Page [open in sandbox]
Get information about the template pages used on Main Page.
api.php?action=query&generator=templates&titles=Main%20Page&prop=info [open in sandbox]
Get pages in the User and Template namespaces that are transcluded on the page Main Page.
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [open in sandbox]

prop=transcludedin (ti)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that transclude the given pages.

Parameters:
tiprop

Which properties to get:

pageid
Page ID of each page.
title
Title of each page.
redirect
Flag if the page is a redirect.
Values (separate with | or alternative): pageid, title, redirect
Default: pageid|title|redirect
tinamespace

Only include pages in these namespaces.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
tishow

Show only items that meet these criteria:

redirect
Only show redirects.
!redirect
Only show non-redirects.
Values (separate with | or alternative): redirect, !redirect
tilimit

How many to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
ticontinue

When more results are available, use this to continue.

list=allcategories (ac)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Enumerate all categories.

Parameters:
acfrom

The category to start enumerating from.

accontinue

When more results are available, use this to continue.

acto

The category to stop enumerating at.

acprefix

Search for all category titles that begin with this value.

acdir

Direction to sort in.

One of the following values: ascending, descending
Default: ascending
acmin

Only return categories with at least this many members.

Type: integer
acmax

Only return categories with at most this many members.

Type: integer
aclimit

How many categories to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
acprop

Which properties to get:

size
Adds number of pages in the category.
hidden
Tags categories that are hidden with __HIDDENCAT__.
Values (separate with | or alternative): size, hidden
Default: (empty)
Examples:
List categories with information on the number of pages in each.
api.php?action=query&list=allcategories&acprop=size [open in sandbox]
Retrieve info about the category page itself for categories beginning List.
api.php?action=query&generator=allcategories&gacprefix=List&prop=info [open in sandbox]

list=alldeletedrevisions (adr)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all deleted revisions by a user or in a namespace.

Parameters:
adrprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Default: ids|timestamp|flags|comment|user
adrlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
adrexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires adrprop=content).

Type: boolean (details)
adrgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires adrprop=content).

Type: boolean (details)
adrparse
Deprecated.

Use action=parse instead. Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.

Type: boolean (details)
adrsection

Only retrieve the content of this section number.

adrdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

adrdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.

adrdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.

Type: boolean (details)
adrcontentformat

Serialization format used for adrdifftotext and expected for output of content.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
adruser

Only list revisions by this user.

Type: user name
adrnamespace

Only list pages in this namespace.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
adrstart

The timestamp to start enumerating from.

May only be used with adruser.
Type: timestamp (allowed formats)
adrend

The timestamp to stop enumerating at.

May only be used with adruser.
Type: timestamp (allowed formats)
adrdir

In which direction to enumerate:

newer
List oldest first. Note: adrstart has to be before adrend.
older
List newest first (default). Note: adrstart has to be later than adrend.
One of the following values: newer, older
Default: older
adrfrom

Start listing at this title.

Cannot be used with adruser.
adrto

Stop listing at this title.

Cannot be used with adruser.
adrprefix

Search for all page titles that begin with this value.

Cannot be used with adruser.
adrexcludeuser

Don't list revisions by this user.

Cannot be used with adruser.
Type: user name
adrtag

Only list revisions tagged with this tag.

adrcontinue

When more results are available, use this to continue.

adrgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)

list=allfileusages (af)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all file usages, including non-existing.

Parameters:
afcontinue

When more results are available, use this to continue.

affrom

The title of the file to start enumerating from.

afto

The title of the file to stop enumerating at.

afprefix

Search for all file titles that begin with this value.

afunique

Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
afprop

Which pieces of information to include:

ids
Adds the page IDs of the using pages (cannot be used with afunique).
title
Adds the title of the file.
Values (separate with | or alternative): ids, title
Default: title
aflimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
afdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

list=allimages (ai)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Enumerate all images sequentially.

Parameters:
aisort

Property to sort by.

One of the following values: name, timestamp
Default: name
aidir

The direction in which to list.

One of the following values: ascending, descending, newer, older
Default: ascending
aifrom

The image title to start enumerating from. Can only be used with aisort=name.

aito

The image title to stop enumerating at. Can only be used with aisort=name.

aicontinue

When more results are available, use this to continue.

aistart

The timestamp to start enumerating from. Can only be used with aisort=timestamp.

Type: timestamp (allowed formats)
aiend

The timestamp to end enumerating. Can only be used with aisort=timestamp.

Type: timestamp (allowed formats)
aiprop

Which file information to get:

timestamp
Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
bitdepth
Adds the bit depth of the version.
badfile
Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth, badfile
Default: timestamp|url
aiprefix

Search for all image titles that begin with this value. Can only be used with aisort=name.

aiminsize

Limit to images with at least this many bytes.

Type: integer
aimaxsize

Limit to images with at most this many bytes.

Type: integer
aisha1

SHA1 hash of image. Overrides aisha1base36.

aisha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

aiuser

Only return files uploaded by this user. Can only be used with aisort=timestamp. Cannot be used together with aifilterbots.

Type: user name
aifilterbots

How to filter files uploaded by bots. Can only be used with aisort=timestamp. Cannot be used together with aiuser.

One of the following values: all, bots, nobots
Default: all
aimime

What MIME types to search for, e.g. image/jpeg.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
ailimit

How many images in total to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Enumerate all links that point to a given namespace.

Parameters:
alcontinue

When more results are available, use this to continue.

alfrom

The title of the link to start enumerating from.

alto

The title of the link to stop enumerating at.

alprefix

Search for all linked titles that begin with this value.

alunique

Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
alprop

Which pieces of information to include:

ids
Adds the page ID of the linking page (cannot be used with alunique).
title
Adds the title of the link.
Values (separate with | or alternative): ids, title
Default: title
alnamespace

The namespace to enumerate.

One of the following values: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Default: 0
allimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
aldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
Examples:
List linked titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [open in sandbox]
List unique linked titles.
api.php?action=query&list=alllinks&alunique=&alfrom=B [open in sandbox]
Gets all linked titles, marking the missing ones.
api.php?action=query&generator=alllinks&galunique=&galfrom=B [open in sandbox]
Gets pages containing the links.
api.php?action=query&generator=alllinks&galfrom=B [open in sandbox]

list=allpages (ap)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Enumerate all pages sequentially in a given namespace.

Parameters:
apfrom

The page title to start enumerating from.

apcontinue

When more results are available, use this to continue.

apto

The page title to stop enumerating at.

apprefix

Search for all page titles that begin with this value.

apnamespace

The namespace to enumerate.

One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Default: 0
apfilterredir

Which pages to list.

One of the following values: all, redirects, nonredirects
Default: all
apminsize

Limit to pages with at least this many bytes.

Type: integer
apmaxsize

Limit to pages with at most this many bytes.

Type: integer
apprtype

Limit to protected pages only.

Values (separate with | or alternative): edit, move, upload
apprlevel

Filter protections based on protection level (must be used with apprtype= parameter).

Values (separate with | or alternative): Can be empty, or editor, sysop
apprfiltercascade

Filter protections based on cascadingness (ignored when apprtype isn't set).

One of the following values: cascading, noncascading, all
Default: all
aplimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
apdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
apfilterlanglinks

Filter based on whether a page has langlinks. Note that this may not consider langlinks added by extensions.

One of the following values: withlanglinks, withoutlanglinks, all
Default: all
apprexpiry

Which protection expiry to filter the page on:

indefinite
Get only pages with indefinite protection expiry.
definite
Get only pages with a definite (specific) protection expiry.
all
Get pages with any protections expiry.
One of the following values: indefinite, definite, all
Default: all

list=allredirects (ar)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all redirects to a namespace.

Parameters:
arcontinue

When more results are available, use this to continue.

arfrom

The title of the redirect to start enumerating from.

arto

The title of the redirect to stop enumerating at.

arprefix

Search for all target pages that begin with this value.

arunique

Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
arprop

Which pieces of information to include:

ids
Adds the page ID of the redirecting page (cannot be used with arunique).
title
Adds the title of the redirect.
fragment
Adds the fragment from the redirect, if any (cannot be used with arunique).
interwiki
Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
Values (separate with | or alternative): ids, title, fragment, interwiki
Default: title
arnamespace

The namespace to enumerate.

One of the following values: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Default: 0
arlimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
ardir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
Examples:
List target pages, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [open in sandbox]
List unique target pages.
api.php?action=query&list=allredirects&arunique=&arfrom=B [open in sandbox]
Gets all target pages, marking the missing ones.
api.php?action=query&generator=allredirects&garunique=&garfrom=B [open in sandbox]
Gets pages containing the redirects.
api.php?action=query&generator=allredirects&garfrom=B [open in sandbox]

list=allrevisions (arv)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all revisions.

Parameters:
arvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Default: ids|timestamp|flags|comment|user
arvlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
arvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires arvprop=content).

Type: boolean (details)
arvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires arvprop=content).

Type: boolean (details)
arvparse
Deprecated.

Use action=parse instead. Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.

Type: boolean (details)
arvsection

Only retrieve the content of this section number.

arvdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

arvdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.

arvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.

Type: boolean (details)
arvcontentformat

Serialization format used for arvdifftotext and expected for output of content.

One of the following values: text/plain, application/json, text/css, text/x-wiki, text/javascript
arvuser

Only list revisions by this user.

Type: user name
arvnamespace

Only list pages in this namespace.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
arvstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
arvend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
arvdir

In which direction to enumerate:

newer
List oldest first. Note: arvstart has to be before arvend.
older
List newest first (default). Note: arvstart has to be later than arvend.
One of the following values: newer, older
Default: older
arvexcludeuser

Don't list revisions by this user.

Type: user name
arvcontinue

When more results are available, use this to continue.

arvgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)

list=alltransclusions (at)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all transclusions (pages embedded using {{x}}), including non-existing.

Parameters:
atcontinue

When more results are available, use this to continue.

atfrom

The title of the transclusion to start enumerating from.

atto

The title of the transclusion to stop enumerating at.

atprefix

Search for all transcluded titles that begin with this value.

atunique

Only show distinct transcluded titles. Cannot be used with atprop=ids. When used as a generator, yields target pages instead of source pages.

Type: boolean (details)
atprop

Which pieces of information to include:

ids
Adds the page ID of the transcluding page (cannot be used with atunique).
title
Adds the title of the transclusion.
Values (separate with | or alternative): ids, title
Default: title
atnamespace

The namespace to enumerate.

One of the following values: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Default: 10
atlimit

How many total items to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
atdir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
Examples:
List transcluded titles, including missing ones, with page IDs they are from, starting at B.
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [open in sandbox]
List unique transcluded titles.
api.php?action=query&list=alltransclusions&atunique=&atfrom=B [open in sandbox]
Gets all transcluded titles, marking the missing ones.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [open in sandbox]
Gets pages containing the transclusions.
api.php?action=query&generator=alltransclusions&gatfrom=B [open in sandbox]

list=allusers (au)

Enumerate all registered users.

Parameters:
aufrom

The user name to start enumerating from.

auto

The user name to stop enumerating at.

auprefix

Search for all users that begin with this value.

audir

Direction to sort in.

One of the following values: ascending, descending
Default: ascending
augroup

Only include users in the given groups.

Values (separate with | or alternative): bot, sysop, bureaucrat, widgeteditor, editor, reviewer, autoreview, visitor, Book_publisher, smwadministrator, smwcurator
auexcludegroup

Exclude users in the given groups.

Values (separate with | or alternative): bot, sysop, bureaucrat, widgeteditor, editor, reviewer, autoreview, visitor, Book_publisher, smwadministrator, smwcurator
aurights

Only include users with the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, dpl_param_update_rules, dpl_param_delete_rules, usermerge, replacetext, gadgets-edit, gadgets-definition-edit, nuke, renameuser, wikiadmin, editor, bluespiceabout-viewspecialpage, bookshelfbookmanager-viewspecialpage, bookshelfbookui-viewspecialpage, checklistmodify, bluespiceconfigmanager-viewspecialpage, dashboards-viewspecialpage-userdashboard, extendedsearch-search-specialpage, extendedsearch-search-wikipage, extendedsearch-search-repofile, extendedsearch-search-externalfile, statistic-viewspecialpage, groupmanager-viewspecialpage, interwikilinks-viewspecialpage, namespacemanager-viewspecialpage, pageaccess-viewspecialpage, pageassignable, pageassignments, pagetemplatesadmin-viewspecialpage, permissionmanager-viewspecialpage, bs-privacy-admin, rssfeeder-viewspecialpage, viewreaders, uemodulebookpdf-export, uemodulepdf-export, uemodulepdfrecursive-export, uemodulepdfsubpages-export, usagetracker-update, usermanager-viewspecialpage, viewedittab, editrestrictedfields, createclass, multipageedit, categorymanager-viewspecialpage, rating-read, rating-write, rating-archive, rating-viewspecialpage, readconfirmationremind, remindereditall, expirearticle, generatepages, workflowview, workflowedit, workflowlist, social-deleteothers, social-editothers, social-source, social-editothersprofile, socialprofile-viewspecialpage, social-tagging, duplicate, editwidgets, review, validate, autoreview, autoreviewrestore, unreviewedpages, movestable, stablesettings, smw-admin, smw-patternedit, smw-schemaedit, smw-pageedit, geocode
Maximum number of values is 50 (500 for bots).
auprop

Which pieces of information to include:

blockinfo
Adds the information about a current block on the user.
groups
Lists groups that the user is in. This uses more server resources and may return fewer results than the limit.
implicitgroups
Lists all the groups the user is automatically in.
rights
Lists rights that the user has.
editcount
Adds the edit count of the user.
registration
Adds the timestamp of when the user registered if available (may be blank).
centralids
Adds the central IDs and attachment status for the user.
Values (separate with | or alternative): blockinfo, groups, implicitgroups, rights, editcount, registration, centralids
aulimit

How many total user names to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
auwitheditsonly

Only list users who have made edits.

Type: boolean (details)
auactiveusers

Only list users active in the last 30 days.

Type: boolean (details)
auattachedwiki

With auprop=centralids, also indicate whether the user is attached with the wiki identified by this ID.

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that link to the given page.

Parameters:
bltitle

Title to search. Cannot be used together with blpageid.

blpageid

Page ID to search. Cannot be used together with bltitle.

Type: integer
blcontinue

When more results are available, use this to continue.

blnamespace

The namespace to enumerate.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
bldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
blfilterredir

How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.

One of the following values: all, redirects, nonredirects
Default: all
bllimit

How many total pages to return. If blredirect is enabled, the limit applies to each level separately (which means up to 2 * bllimit results may be returned).

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
blredirect

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

Type: boolean (details)

list=blocks (bk)

List all blocked users and IP addresses.

Parameters:
bkstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
bkend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
bkdir

In which direction to enumerate:

newer
List oldest first. Note: bkstart has to be before bkend.
older
List newest first (default). Note: bkstart has to be later than bkend.
One of the following values: newer, older
Default: older
bkids

List of block IDs to list (optional).

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
bkusers

List of users to search for (optional).

Type: list of user names
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
bkip

Get all blocks applying to this IP address or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.

bklimit

The maximum number of blocks to list.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
bkprop

Which properties to get:

id
Adds the ID of the block.
user
Adds the username of the blocked user.
userid
Adds the user ID of the blocked user.
by
Adds the username of the blocking user.
byid
Adds the user ID of the blocking user.
timestamp
Adds the timestamp of when the block was given.
expiry
Adds the timestamp of when the block expires.
reason
Adds the reason given for the block.
range
Adds the range of IP addresses affected by the block.
flags
Tags the ban with (autoblock, anononly, etc.).
Values (separate with | or alternative): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
Default: id|user|by|timestamp|expiry|reason|flags
bkshow

Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.

Values (separate with | or alternative): account, !account, temp, !temp, ip, !ip, range, !range
bkcontinue

When more results are available, use this to continue.

list=bsbookshelf (bsbs)

  • This module requires read rights.
  • Source: BlueSpiceBookshelf
  • License: GPL-3.0-only

Allows querying in all books.

list=categorymembers (cm)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all pages in a given category.

Parameters:
cmtitle

Which category to enumerate (required). Must include the Category: prefix. Cannot be used together with cmpageid.

cmpageid

Page ID of the category to enumerate. Cannot be used together with cmtitle.

Type: integer
cmprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
sortkey
Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
Adds the timestamp of when the page was included.
Values (separate with | or alternative): ids, title, sortkey, sortkeyprefix, type, timestamp
Default: ids|title
cmnamespace

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
cmtype

Which type of category members to include. Ignored when cmsort=timestamp is set.

Values (separate with | or alternative): page, subcat, file
Default: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
cmsort

Property to sort by.

One of the following values: sortkey, timestamp
Default: sortkey
cmdir

In which direction to sort.

One of the following values: asc, desc, ascending, descending, newer, older
Default: ascending
cmstart

Timestamp to start listing from. Can only be used with cmsort=timestamp.

Type: timestamp (allowed formats)
cmend

Timestamp to end listing at. Can only be used with cmsort=timestamp.

Type: timestamp (allowed formats)
cmstarthexsortkey

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmendhexsortkey

Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmstartsortkeyprefix

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

cmendsortkeyprefix

Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

cmstartsortkey
Deprecated.

Use cmstarthexsortkey instead.

cmendsortkey
Deprecated.

Use cmendhexsortkey instead.

list=configuredpages (cp)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: Flagged Revisions
  • License: GPL-2.0-or-later

Enumerate all pages that have custom review configurations.

Parameters:
cpstart

Start listing at this page ID.

Type: integer
cpend

Stop listing at this page ID.

Type: integer
cpdir

In which direction to enumerate:

newer
List oldest first. Note: cpstart has to be before cpend.
older
List newest first (default). Note: cpstart has to be later than cpend.
One of the following values: newer, older
Default: newer
cpnamespace

The namespaces to enumerate.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
cpdefault

The default page view version.

One of the following values: latest, stable
cpautoreview

Review/autoreview restriction level.

One of the following values: sysop, none
cplimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
Examples:
Show a list of pages with custom review configurations
api.php?action=query&list=configuredpages&cpnamespace=0 [open in sandbox]
Get some info about pages with custom review configurations
api.php?action=query&generator=configuredpages&gcplimit=4&prop=info [open in sandbox]

list=deletedrevs (dr)

  • This module is deprecated.
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List deleted revisions.

Operates in three modes:

  1. List deleted revisions for the given titles, sorted by timestamp.
  2. List deleted contributions for the given user, sorted by timestamp (no titles specified).
  3. List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set).

Certain parameters only apply to some modes and are ignored in others.

Parameters:
drstart

The timestamp to start enumerating from.

Modes: 1, 2
Type: timestamp (allowed formats)
drend

The timestamp to stop enumerating at.

Modes: 1, 2
Type: timestamp (allowed formats)
drdir

In which direction to enumerate:

newer
List oldest first. Note: drstart has to be before drend.
older
List newest first (default). Note: drstart has to be later than drend.
Modes: 1, 3
One of the following values: newer, older
Default: older
drfrom

Start listing at this title.

Mode: 3
drto

Stop listing at this title.

Mode: 3
drprefix

Search for all page titles that begin with this value.

Mode: 3
drunique

List only one revision for each page.

Mode: 3
Type: boolean (details)
drnamespace

Only list pages in this namespace.

Mode: 3
One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Default: 0
drtag

Only list revisions tagged with this tag.

druser

Only list revisions by this user.

Type: user name
drexcludeuser

Don't list revisions by this user.

Type: user name
drprop

Which properties to get:

revid
Adds the revision ID of the deleted revision.
parentid
Adds the revision ID of the previous revision to the page.
user
Adds the user who made the revision.
userid
Adds the ID of the user who made the revision.
comment
Adds the comment of the revision.
parsedcomment
Adds the parsed comment of the revision.
minor
Tags if the revision is minor.
len
Adds the length (bytes) of the revision.
sha1
Adds the SHA-1 (base 16) of the revision.
content
Adds the content of the revision.
token
Deprecated. Gives the edit token.
tags
Tags for the revision.
Values (separate with | or alternative): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags
Default: user|comment
drlimit

The maximum amount of revisions to list.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
drcontinue

When more results are available, use this to continue.

Examples:
List the last deleted revisions of the pages Main Page and Talk:Main Page, with content (mode 1).
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [open in sandbox]
List the last 50 deleted contributions by Bob (mode 2).
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [open in sandbox]
List the first 50 deleted revisions in the main namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [open in sandbox]
List the first 50 deleted pages in the Talk namespace (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [open in sandbox]

list=embeddedin (ei)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that embed (transclude) the given title.

Parameters:
eititle

Title to search. Cannot be used together with eipageid.

eipageid

Page ID to search. Cannot be used together with eititle.

Type: integer
eicontinue

When more results are available, use this to continue.

einamespace

The namespace to enumerate.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
eidir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
eifilterredir

How to filter for redirects.

One of the following values: all, redirects, nonredirects
Default: all
eilimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10

list=exturlusage (eu)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Enumerate pages that contain a given URL.

Parameters:
euprop

Which pieces of information to include:

ids
Adds the ID of page.
title
Adds the title and namespace ID of the page.
url
Adds the URL used in the page.
Values (separate with | or alternative): ids, title, url
Default: ids|title|url
euoffset

When more results are available, use this to continue.

Type: integer
euprotocol

Protocol of the URL. If empty and euquery is set, the protocol is http. Leave both this and euquery empty to list all external links.

One of the following values: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp, file, file
Default: (empty)
euquery

Search string without protocol. See Special:LinkSearch. Leave empty to list all external links.

eunamespace

The page namespaces to enumerate.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
eulimit

How many pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
euexpandurl

Expand protocol-relative URLs with the canonical protocol.

Type: boolean (details)

list=filearchive (fa)

Enumerate all deleted files sequentially.

Parameters:
fafrom

The image title to start enumerating from.

fato

The image title to stop enumerating at.

faprefix

Search for all image titles that begin with this value.

fadir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
fasha1

SHA1 hash of image. Overrides fasha1base36.

fasha1base36

SHA1 hash of image in base 36 (used in MediaWiki).

faprop

Which image information to get:

sha1
Adds SHA-1 hash for the image.
timestamp
Adds timestamp for the uploaded version.
user
Adds user who uploaded the image version.
size
Adds the size of the image in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
description
Adds description of the image version.
parseddescription
Parse the description of the version.
mime
Adds MIME of the image.
mediatype
Adds the media type of the image.
metadata
Lists Exif metadata for the version of the image.
bitdepth
Adds the bit depth of the version.
archivename
Adds the filename of the archive version for non-latest versions.
Values (separate with | or alternative): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename
Default: timestamp
falimit

How many images to return in total.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
facontinue

When more results are available, use this to continue.

Example:
Show a list of all deleted files.
api.php?action=query&list=filearchive [open in sandbox]

list=gadgetcategories (gc)

Returns a list of gadget categories.

Parameters:
gcprop

What gadget category information to get:

name
Internal category name.
title
Category title.
members
Number of gadgets in category.
Values (separate with | or alternative): name, title, members
Default: name
gcnames

Names of categories to retrieve.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
Examples:
Get a list of existing gadget categories
api.php?action=query&list=gadgetcategories [open in sandbox]
Get all information about categories named "foo" and "bar"
api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members [open in sandbox]

list=gadgets (ga)

Returns a list of gadgets used on this wiki.

Parameters:
gaprop

What gadget information to get:

id
Internal gadget ID.
metadata
The gadget metadata.
desc
Gadget description transformed into HTML (can be slow, use only if really needed).
Values (separate with | or alternative): id, metadata, desc
Default: id|metadata
gacategories

Gadgets from what categories to retrieve.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
gaids

IDs of gadgets to retrieve.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
gaallowedonly

List only gadgets allowed to current user.

Type: boolean (details)
gaenabledonly

List only gadgets enabled by current user.

Type: boolean (details)
Examples:
Get a list of gadgets along with their descriptions
api.php?action=query&list=gadgets&gaprop=id|desc [open in sandbox]
Get a list of gadgets with all possible properties
api.php?action=query&list=gadgets&gaprop=id|metadata|desc [open in sandbox]
Get a list of gadgets belonging to category "foo"
api.php?action=query&list=gadgets&gacategories=foo [open in sandbox]
Get information about gadgets "foo" and "bar"
api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata [open in sandbox]
Get a list of gadgets enabled by current user
api.php?action=query&list=gadgets&gaenabledonly [open in sandbox]

list=imageusage (iu)

  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that use the given image title.

Parameters:
iutitle

Title to search. Cannot be used together with iupageid.

iupageid

Page ID to search. Cannot be used together with iutitle.

Type: integer
iucontinue

When more results are available, use this to continue.

iunamespace

The namespace to enumerate.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 828, 829, 1504, 1505, 1506, 1507, 2300, 2301, 2302, 2303, 3000, 3001, 3004, 3005, 3008, 3009, 3010, 3011, 3012, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021
Maximum number of values is 50 (500 for bots).
To specify all values, use *.
iudir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
iufilterredir

How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.

One of the following values: all, redirects, nonredirects
Default: all
iulimit

How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
iuredirect

If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.

Type: boolean (details)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that link to the given interwiki link.

Can be used to find all links with a prefix, or all links to a title (with a given prefix). Using neither parameter is effectively "all interwiki links".

Parameters:
iwblprefix

Prefix for the interwiki.

iwbltitle

Interwiki link to search for. Must be used with iwblblprefix.

iwblcontinue

When more results are available, use this to continue.

iwbllimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
iwblprop

Which properties to get:

iwprefix
Adds the prefix of the interwiki.
iwtitle
Adds the title of the interwiki.
Values (separate with | or alternative): iwprefix, iwtitle
Default: (empty)
iwbldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Find all pages that link to the given language link.

Can be used to find all links with a language code, or all links to a title (with a given language). Using neither parameter is effectively "all language links".

Note that this may not consider language links added by extensions.

Parameters:
lbllang

Language for the language link.

lbltitle

Language link to search for. Must be used with lbllang.

lblcontinue

When more results are available, use this to continue.

lbllimit

How many total pages to return.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 10
lblprop

Which properties to get:

lllang
Adds the language code of the language link.
lltitle
Adds the title of the language link.
Values (separate with | or alternative): lllang, lltitle
Default: (empty)
lbldir

The direction in which to list.

One of the following values: ascending, descending
Default: ascending

list=logevents (le)

Get events from logs.

Parameters:
leprop

Which properties to get:

ids
Adds the ID of the log event.
title<