MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
Modulu nagusia
- Iturria: MediaWiki
- Lizentzia: GPL-2.0-or-later
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.
Testing: For ease of testing API requests, see Special:ApiSandbox.
- action
Zein ekintza burutuko da.
- abusefiltercheckmatch
- Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.
- abusefilterchecksyntax
- Check syntax of an AbuseFilter filter.
- abusefilterevalexpression
- Evaluates an AbuseFilter expression.
- abusefilterunblockautopromote
- Unblocks a user from receiving autopromotions due to an abusefilter consequence.
- antispoof
- Check a username against AntiSpoof's normalisation checks.
- block
- Blokeatu erabiltzaile bat.
- bouncehandler
- Receive a bounce email and process it to handle the failing recipient.
- categorytree
- Internal module for the CategoryTree extension.
- centralauthtoken
- Fetch a centralauthtoken for making an authenticated request to an attached wiki.
- centralnoticecdncacheupdatebanner
- Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
- centralnoticechoicedata
- Get data needed to choose a banner for a given project and language
- centralnoticequerycampaign
- Get all configuration settings for a campaign.
- changeauthenticationdata
- Aldatu autentifikazio datuak uneko erabiltzailearentzat.
- checktoken
- Check the validity of a token from action=query&meta=tokens.
- cirrus-config-dump
- Dump of CirrusSearch configuration.
- cirrus-mapping-dump
- Dump of CirrusSearch mapping for this wiki.
- cirrus-settings-dump
- Dump of CirrusSearch settings for this wiki.
- clearhasmsg
- Clears the
hasmsgflag for the current user. - clientlogin
- Hasi saioa wikiera fluxu interaktiboa erabiliz.
- compare
- Bi orrien arteko ezberdintasuna jaso.
- createaccount
- Erabiltzaile kontu berria sortu.
- 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.
- cxconfiguration
- Fetch the Content Translation configuration json for the given language pair.
- cxdelete
- Delete a draft translation created using the Content Translation extension.
- cxpublish
- Save a page created using the Content Translation extension.
- cxsave
- This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
- cxsuggestionlist
- Manage the suggestion lists. Add suggestions to lists and remove them.
- cxtoken
- Get JWT tokens to authenticate with cxserver.
- delete
- Orrialde bat ezabatu.
- deleteglobalaccount
- Delete a global user.
- echomarkread
- Mark notifications as read for the current user.
- echomarkseen
- Mark notifications as seen for the current user.
- edit
- Orrialdeak sortu eta aldatu.
- editmassmessagelist
- Edit a mass message delivery list.
- emailuser
- Erabiltzaileari e-maila bidali
- expandtemplates
- Wikitesturako txantiloi guztiak zabaldu.
- fancycaptchareload
- Get a new FancyCaptcha.
- featuredfeed
- Returns a featured content feed.
- feedcontributions
- Returns a user contributions feed.
- feedrecentchanges
- Returns a recent changes feed.
- feedwatchlist
- Returns a watchlist feed.
- filerevert
- Artxibo bat bertsio zaharrera bueltatu.
- flow
- Allows actions to be taken on Flow pages.
- flow-parsoid-utils
- Convert text between wikitext and HTML.
- flowthank
- Send a public thank-you notification for a Flow comment.
- globalblock
- Globally block or unblock a user.
- globalpreferenceoverrides
- Change local overrides for global preferences for the current user.
- globalpreferences
- Change global preferences of the current user.
- globaluserrights
- Add/remove a user to/from global groups.
- graph
- Access graph tag functionality.
- help
- Display help for the specified modules.
- imagerotate
- Modulu hau ezgaitu da.
- import
- Import a page from another wiki, or from an XML file.
- jsonconfig
- Allows direct access to JsonConfig subsystem.
- jsondata
- Retrieve localized JSON data.
- languagesearch
- Search for language names in any script.
- linkaccount
- Link an account from a third-party provider to the current user.
- login
- Log in and get authentication cookies.
- logout
- Saioa itxi eta saioko datuak garbitu.
- managetags
- Perform management tasks relating to change tags.
- massmessage
- Send a message to a list of pages.
- mergehistory
- Orrialdeen historiak erakutsi.
- mobileview
- Returns data needed for mobile views.
- move
- Orrialde bat mugitu
- oathvalidate
- Validate a two-factor authentication (OATH) token.
- opensearch
- Search the wiki using the OpenSearch protocol.
- options
- Change preferences of the current user.
- paraminfo
- API moduluei buruzko informazioa eskuratu.
- parse
- Parses content and returns parser output.
- parser-migration
- Bi konfigurazio txukun eta desberdin dituen orrialdea aztertu.
- parsoid-batch
- Batch API for Parsoid
- patrol
- Orri edo berrikusketa bat patruilatu.
- protect
- Aldatu orri baten segurtasun maila.
- purge
- Purge the cache for the given titles.
- query
- Fetch data from and about MediaWiki.
- readinglists
- Reading list write operations.
- record-lint
- Record a lint error in the database
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Send a password reset email to a user.
- revisiondelete
- Delete and undelete revisions.
- rollback
- Undo the last edit to the page.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- sanitize-mapdata
- Performs data validation for Kartographer extension
- scribunto-console
- Internal module for servicing XHR requests from the Scribunto console.
- setglobalaccountstatus
- Set a global user's status.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Change the language of a page.
- shortenurl
- Shorten a long URL into a shorter one.
- sitematrix
- Get Wikimedia sites list.
- spamblacklist
- Validate one or more URLs against the SpamBlacklist.
- stashedit
- Prepare an edit in shared cache.
- strikevote
- Allows admins to strike or unstrike a vote.
- tag
- Add or remove change tags from individual revisions or log entries.
- templatedata
- Fetch data stored by the TemplateData extension.
- thank
- Send a thank-you notification to an editor.
- titleblacklist
- Validate a page title, filename, or username against the TitleBlacklist.
- transcodereset
- Users with the 'transcode-reset' right can reset and re-run a transcode job.
- ulslocalization
- Get the localization of ULS in the given language.
- 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
- HTML5 itzultzen du orri baterako Parsoid zerbitzutik.
- 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.
- webapp-manifest
- Returns a webapp manifest.
- zeroconfig
- Get configuration of the Zero extension.
- tokens
- Zaharkitua. Get tokens for data-modifying actions.
- One of the following values: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, antispoof, block, bouncehandler, categorytree, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, cspreport, cxconfiguration, cxdelete, cxpublish, cxsave, cxsuggestionlist, cxtoken, delete, deleteglobalaccount, echomarkread, echomarkseen, edit, editmassmessagelist, emailuser, expandtemplates, fancycaptchareload, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flow, flow-parsoid-utils, flowthank, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, graph, help, imagerotate, import, jsonconfig, jsondata, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, mobileview, move, oathvalidate, opensearch, options, paraminfo, parse, parser-migration, parsoid-batch, patrol, protect, purge, query, readinglists, record-lint, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, sanitize-mapdata, scribunto-console, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, stashedit, strikevote, tag, templatedata, thank, titleblacklist, transcodereset, ulslocalization, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, visualeditor, visualeditoredit, watch, webapp-manifest, zeroconfig, tokens
- Lehenetsia: help
- format
Irteerako formatua.
- 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
- Lehenetsia: 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.- Mota: osokoa
- smaxage
Set the
s-maxageHTTP cache control header to this many seconds. Errors are never cached.- Mota: osokoa
- Lehenetsia: 0
- maxage
Set the
max-ageHTTP cache control header to this many seconds. Errors are never cached.- Mota: osokoa
- Lehenetsia: 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
Egiaztatu erabiltzaile hau izendatutakoa dela.
- Mota: erabiltzaile-izena
- requestid
Hemen emandako edozein balio erantzunean kontuan hartuko da. Eskaerak ezberdintzeko erabili ahalko da.
- servedby
Sartu eskaera emaitzetan zerbitzariaren izena.
- Mota: boolearra (xehetasunak)
- curtimestamp
Emaitzan oraingo denbora-zigilua jarri.
- Mota: boolearra (xehetasunak)
- responselanginfo
Include the languages used for uselang and errorlang in the result.
- Mota: boolearra (xehetasunak)
- 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
Originheader 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 theOriginheader, a 403 response will be returned. If this parameter matches theOriginheader and the origin is whitelisted, theAccess-Control-Allow-OriginandAccess-Control-Allow-Credentialsheaders will be set.For non-authenticated requests, specify the value *. This will cause the
Access-Control-Allow-Originheader to be set, butAccess-Control-Allow-Credentialswill befalseand 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.
- Lehenetsia: 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
- Lehenetsia: 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.
- Lehenetsia: uselang
- errorsuselocal
If given, error texts will use locally-customized messages from the MediaWiki namespace.
- Mota: boolearra (xehetasunak)
- centralauthtoken
When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).
- Modulu nagusirako laguntza.
- api.php?action=help [open in sandbox]
- Laguntza guztia orrialde batean.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
Datu-motak
Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.
Some parameter types in API requests need further explanation:
- boolean
- Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
- timestamp
- Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
- ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
- ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
- MediaWiki format, 20010115145600
- Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
- EXIF format, 2001:01:15 14:56:00
- RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
- RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
- C ctime format, Mon Jan 15 14:56:00 2001
- Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
- The string now
- alternative multiple-value separator
- Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.
Templated parameters
Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.
Kredituak
API garatzaileak:
- Roan Kattouw (garatzaile nagusia, 2007ko ira.–2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Yuri Astrakhan (sortzailea, garatzaile nagusia, 2006ko ira.–2007ko ira.)
- Brad Jorsch (garatzaile nagusia 2013–gaur egun)
Mesedez, bidal iezazkiguzu zure iruzkinak, iradokizunak eta galderak mediawiki-api@lists.wikimedia.org helbidera edo bete ezazu errore-txostena https://phabricator.wikimedia.org/ helbidean.