MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Huvudmodul
- Source: MediaWiki
- License: GPL-2.0-or-later
Status: MediaWikis API är ett moget och stabilt gränssnitt som aktivt underhålls och förbättras. Vi försöker undvika det men ibland behöver vi kanske behöver göra störande ändringar; prenumerera på sändlistan mediawiki-api-announce för uppdateringsaviseringar.
Felaktiga begäran: När felaktiga begäran skickas till API:et kommer en HTTP-header skickas med nyckeln "MediaWiki-API-Error" och sedan kommer både värdet i headern och felkoden som skickades tillbaka anges som samma värde. För mer information se API: Fel och varningar.
Testning: För enkelt testning av API-begäran, se Special:ApiSandbox.
- action
Vilken åtgärd som ska utföras.
- abusefiltercheckmatch
- Kontrollera om ett missbruksfilter matchar en grupp variabler, en redigering eller en händelse som är loggad i missbruksfiltret.
- abusefilterchecksyntax
- Kontrollera syntaxen för ett missbruksfilter.
- abusefilterevalexpression
- Utvärderar uttryck i ett missbruksfilter.
- abusefilterunblockautopromote
- Upphäver blockering för en användare från att få automatiska befordringar p.g.a. konsekvenser från ett missbruksfilter.
- abuselogprivatedetails
- Visa privata detaljer för en post i missbruksloggen.
- acquiretempusername
- Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
- antispoof
- Kontrollera ett användarnamn mot AntiSpoofs normaliseringskontroller.
- block
- Blockera en användare.
- centralauthtoken
- Hämta en centralauthtoken för att göra en autentiserad begäran till en ansluten wiki.
- centralnoticecdncacheupdatebanner
- Begär rensning av bannerinnehåll lagrat i CDN (front-end) cache för anonyma användare, för den begärda bannern och språket
- centralnoticechoicedata
- Få information som behövs för att välja en banner för ett visst projekt och språk
- centralnoticequerycampaign
- Få alla konfigurationsinställningar för en kampanj.
- changeauthenticationdata
- Ändra autentiseringsdata för aktuell användare.
- changecontentmodel
- Ändra innehållsmodellen för en sida
- checktoken
- Kontrollera giltigheten av en nyckel från action=query&meta=tokens.
- cirrus-config-dump
- Dump av CirrusSearch-konfiguration.
- cirrus-mapping-dump
- Dump av CirrusSearch-mappning för denna wiki.
- cirrus-profiles-dump
- Dump av CirrusSearch-profiler för denna wiki.
- cirrus-settings-dump
- Dumpa av CirrusSearch-inställningar för denna wiki.
- clearhasmsg
- Rensa
hasmsg
-flaggan för den aktuella användaren. - clientlogin
- Logga till på wikin med det interaktiva flödet.
- compare
- Hämta skillnaden mellan två sidor.
- createaccount
- Skapa ett nytt användarkonto.
- createlocalaccount
- Tvinga skapa ett lokalt konto
- cxdelete
- Radera ett översättningsutkast som skapats med hjälp av tillägget Innehållsöversättning.
- cxsuggestionlist
- Hantera förslagslistor. Lägg till förslag i listor och ta bort dem.
- cxtoken
- Hämta JWT-nyckel för att autentisera med cxserver.
- delete
- Radera en sida.
- deleteglobalaccount
- Radera en global användare.
- discussiontoolsedit
- Posta ett inlägg på en diskussionssida.
- discussiontoolsfindcomment
- Hitta en kommentar via dess ID eller namn.
- discussiontoolsgetsubscriptions
- Hämta prenumerationsstatus för angivna ämnen.
- discussiontoolssubscribe
- Prenumerera (eller sluta prenumerera) för att ta emot aviseringar om ett ämne.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Manually trigger a notification to a user
- echomarkread
- Markera aviseringar som lästa för den aktuella användaren.
- echomarkseen
- Märk aviseringar som lästa för aktuell användare.
- echomute
- Tysta eller sluta tysta aviseringar från vissa användare eller sidor.
- edit
- Skapa och redigera sidor.
- editmassmessagelist
- Redigera leveranslista för massmeddelanden
- emailuser
- Skicka e-post till en användare.
- expandtemplates
- Expanderar alla mallar inom wikitext.
- featuredfeed
- Returnerar ett flöde för utvalt innehåll.
- feedcontributions
- Returnerar en användares bidragsflöde.
- feedrecentchanges
- Returnerar ett flöde med senaste ändringar.
- feedwatchlist
- Returnerar ett flöde från bevakningslistan.
- filerevert
- Återställ en fil till en äldre version.
- flow
- Gör det möjligt att utföra åtgärder på Structured Discussions-sidor.
- flow-parsoid-utils
- Konvertera text mellan wikitext och HTML.
- flowthank
- Skicka en offentlig tack-avisering för en Flow-kommentar.
- globalblock
- Blockera eller avblockera en användare globalt.
- globalpreferenceoverrides
- Ändra lokala åsidosättanden för globala inställningar till nuvarande användare.
- globalpreferences
- Ändra globala inställningar för nuvarande användare.
- globaluserrights
- Lägg till/ta bort en användare till/från globala grupper.
- growthmanagementorlist
- Manage information in the structured mentor list (usually stored in MediaWiki:GrowthMentors.json). This module can be used by both current and future mentors (to add themselves or change their details) and administrators (for all users).
- growthmentordashboardupdatedata
- Schedule an extraordinary update of the mentee overview module in the mentor dashboard. You can only schedule one update per two hours for performance reasons.
- growthsetmenteestatus
- Set mentee's status (allows mentees to enable/disable mentorship module, or to opt-out entirely, which deletes the mentee/mentor relationship)
- growthsetmentor
- Sätt användares fadder. Ändringen loggas offentligt.
- growthstarmentee
- Markera eller avmarkera en nybörjare som stjärnmärkt av nuvarande användare (lagras privat och loggas inte)
- help
- Visa hjälp för de angivna modulerna.
- homepagequestionstore
- Hämta formaterade frågor ställda via hemsidemoduler
- imagerotate
- Denna modul har inaktiverats.
- import
- Importer en sida från en annan wiki eller från en XML-fil.
- jsonconfig
- Tillåter direkt tillgång till JsonConfigs undersystem
- languagesearch
- Sök efter språknamn i valfritt skriftsystem.
- linkaccount
- Länka ett konto från en tredjepartsleverantör till nuvarande användare.
- login
- Logga in och hämta autentiseringskakor.
- logout
- Logga ut och rensa sessionsdata.
- managetags
- Utför hanterings uppgifter relaterade till förändrings taggar.
- massmessage
- Skicka ett meddelande till en lista över sidor.
- mergehistory
- Sammanfoga sidhistoriker.
- move
- Flytta en sida.
- opensearch
- Sök wikin med protokollet OpenSearch.
- options
- Ändra inställningar för nuvarande användare.
- paraminfo
- Få information om API moduler.
- parse
- Parses content and returns parser output.
- patrol
- Patrullera en sida eller en version.
- protect
- Ändra skyddsnivån för en sida.
- purge
- Rensa cachen för angivna titlar.
- query
- Fetch data from and about MediaWiki.
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Send a password reset email to a user.
- revisiondelete
- Radera och återställ sidversioner.
- rollback
- Ångra den senaste redigeringen på sidan.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setglobalaccountstatus
- Ändra en global användares status.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Ändra språket på en sida.
- shortenurl
- Korta ner en lång URL till en kortare.
- sitematrix
- Hämta Wikimedia sidlistor.
- spamblacklist
- Validera en eller mer URL:er mot spamblockeringslistan.
- streamconfigs
- Visar konfiguration för händelseström. Återkommer endast format=json med formatversion=2.
- strikevote
- Tillåter administratörer att slå eller avbryta en omröstning.
- sxdelete
- Radera översättningen av utkastsavsnittet och dess parallella korpus från databasen.
- tag
- Lägg till eller ta bort ändringsmärken från individuella sidversioner eller loggposter.
- templatedata
- Hämta data som lagras av TemplateData-tillägget.
- thank
- Skicka ett tack-avisering till en redigerare.
- titleblacklist
- Validera en sidtitel, filnamn eller användare mot TitleBlacklist.
- torblock
- Check if an IP address is blocked as a Tor exit node.
- transcodereset
- Användare med "transcode-reset"-rättigheten kan återställa och köra om ett transkodningsjobb.
- unblock
- Upphäv en användares blockering.
- undelete
- Återställ sidversioner för en raderad sida.
- unlinkaccount
- Ta bort ett länkat tredjepartskonto från aktuell användare.
- upload
- Ladda upp en fil eller hämta status för väntande uppladdningar.
- userrights
- Ändra en användares gruppmedlemskap.
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- Lägg till eller ta bort sidor från aktuell användares bevakningslista.
- webapp-manifest
- Returnerar ett webbappsmanifest.
- webauthn
- API Module to communicate between server and client during registration/authentication process.
- wikilove
- Ge WikiLove till en annan användare.
- bouncehandler
- Intern. Få ett studsat e-post meddelande och bearbeta detta för att hantera den misslyckade mottagaren.
- categorytree
- Intern. Intern modul för tillägget CategoryTree.
- cirrus-check-sanity
- Intern. Reports on the correctness of a range of page ids in the search index
- collection
- Intern. API module for performing various operations on a wiki user's collection.
- cspreport
- Intern. 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.
- cxcheckunreviewed
- Intern. Check if any fast, unreviewed translation has been published recently for the current user.
- cxpublish
- Intern. Spara en sida skapad med tillägget för innehållsöversättning.
- cxpublishsection
- Intern. Spara ett avsnitt som skapades med avsnittsöversättningsfunktionen i tillägget Innehållsöversättning.
- cxsave
- Intern. Denna modul låter översättningsutkast sparas efter avsnitt för att spara bandbredd och för att samla in parallell text.
- cxsplit
- Intern. Create and save a section translation to database, for every translated section of the given article translation
- discussiontoolscompare
- Intern. Få information om kommentarsändringar mellan två sidversioner.
- discussiontoolspageinfo
- Intern. Returnerar metadata som krävs för att initialisera diskussionsverktygen.
- discussiontoolspreview
- Intern. Förhandsgranska ett meddelande på en diskussionssida.
- echopushsubscriptions
- Intern. Hantera push-prenumerationer för nuvarande användare.
- editcheckreferenceurl
- Intern. Check the status of a URL for use as a reference.
- fancycaptchareload
- Intern. Hämta en ny FancyCaptcha.
- growthinvalidateimagerecommendation
- Intern. Ogiltigt bildrekommendationsuppgift
- growthinvalidatepersonalizedpraisesuggestion
- Intern. Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
- helppanelquestionposter
- Intern. Hantera frågor som läggs upp via hjälppanelen för nuvarande användare.
- jsondata
- Intern. Hämta lokaliserad JSON-data.
- oathvalidate
- Intern. Bekräfta en nyckel för tvåfaktorsautentisering (OATH).
- parser-migration
- Intern. Parse a page with two different parser configurations.
- readinglists
- Intern. Skrivoperationer för läslistor.
- sanitize-mapdata
- Intern. Utför datavalidering för tillägget Kartographer
- scribunto-console
- Intern. Intern modul för att betjäna XHR-förfrågningar från Scribunto-konsolen.
- securepollauth
- Intern. Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- Intern. Prepare an edit in shared cache.
- sxsave
- Intern. Spara översättningsskiss för avsnittet och lagra den parallella texten
- timedtext
- Intern. Tillhandahåller tajmad textinnehåll för användande av <track> elements
- ulslocalization
- Intern. Få lokalanpassningen av ULS på ett visst språk.
- ulssetlang
- Intern. Uppdatera det språk som användaren valt för gränssnittet.
- visualeditor
- Intern. Returnerar HTML5 för en sida från Parsoid-tjänsten.
- visualeditoredit
- Intern. Spara en HTML5-sida till MediaWiki (konverterad till wikitext via Parsoid-tjänsten).
- wikimediaeventsblockededit
- Intern. Log information about blocked edit attempts
- Ett av följande värden: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, createlocalaccount, cxdelete, cxsuggestionlist, cxtoken, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flow-parsoid-utils, flow, flowthank, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, growthmanagementorlist, growthmentordashboardupdatedata, growthsetmenteestatus, growthsetmentor, growthstarmentee, help, homepagequestionstore, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, sxdelete, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikilove, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, cxcheckunreviewed, cxpublish, cxpublishsection, cxsave, cxsplit, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, echopushsubscriptions, editcheckreferenceurl, fancycaptchareload, growthinvalidateimagerecommendation, growthinvalidatepersonalizedpraisesuggestion, helppanelquestionposter, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, sxsave, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
- Default: help
- format
Formatet för utdata.
- 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).
- Ett av följande värden: 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
Ange headervärdet
s-maxage
till så här många sekunder. Fel cachelagras aldrig.- Type: integer
- The value must be no less than 0.
- Default: 0
- maxage
Ange headervärdet
max-age
till så här många sekunder. Fel cachelagras aldrig.- Type: integer
- The value must be no less than 0.
- Default: 0
- assert
Bekräfta att användaren är inloggad om satt till user, inte inloggad om satt till anon,eller har bot-användarrättigheten om satt till bot.
- Ett av följande värden: anon, bot, user
- assertuser
Verifiera att den nuvarande användaren är den namngivne användaren.
- Typ: användare, genom något av användarnamn och Tillfällig användare
- requestid
Alla värde som anges här kommer att inkluderas i svaret. Kan användas för att särskilja förfrågningar.
- servedby
Inkludera det värdnamn som besvarade förfrågan i resultatet.
- Type: boolean (details)
- curtimestamp
Inkludera den aktuella tidsstämpeln i resultatet.
- Type: boolean (details)
- responselanginfo
Inkluderar de språk som används för uselang och errorlang i resultatet.
- Type: boolean (details)
- origin
När API:et används genom en cross-domain AJAX-begäran (CORS), ange detta till den ursprungliga domänen. Detta måste inkluderas i alla pre-flight-begäran, och mpste därför vara en del av den begärda URI:n (inte i POST-datat). Detta måste överensstämma med en av källorna i headern
Origin
exakt, så den måste sättas till något i stil med http://en.wikipedia.org eller https://meta.wikimedia.org. Om denna parameter inte överensstämmer med headernOrigin
, returneras ett 403-svar. Om denna parameter överensstämmer med headernOrigin
och källan är vitlistad, sätts enAccess-Control-Allow-Origin
-header.- uselang
Språk som ska användas för meddelandeöversättningar. action=query&meta=siteinfo med siprop=languages returnerar en lista med språkkoder, eller ange user för att använda den aktuella användarens språkpreferenser, eller ange content för att använda innehållsspråket.
- Default: user
- variant
Variant of the language. Only works if the base language supports variant conversion.
- 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.
- Ett av följande värden: bc, html, none, plaintext, raw, wikitext
- Default: bc
- errorlang
Språk att använda för varningar och fel. action=query&meta=siteinfo med siprop=languages returnerar en lista över språkkoder eller specifikt content för att använda innehållsspråket på denna wiki, eller specifikt uselang för att använda samma värde som parametern uselang.
- Default: uselang
- errorsuselocal
Om angivet kommer feltexter att använda lokalt anpassade meddelande från namnrymden MediaWiki.
- Type: boolean (details)
- centralauthtoken
När du använder API:et med en AJAX-begäran (CORS) över flera domäner kan du använda detta för att autentisera som den aktuella SUL-användaren. Använd action=centralauthtoken på denna wiki för att hämta tecken innan du gör CORS-begäran. Varje tecken får endast användas en gång och går ut efter 10 sekunder. Detta bör ingå i alla förfrågningar före flygning och bör därför ingå i URI begäran (inte POST-body).
- Hjälp för huvudmodul
- api.php?action=help [open in sandbox]
- All hjälp på en sida
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
Data types
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.
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.
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.
- expiry
Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.
- timestamp
Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.
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.
Credits
API developers:
- Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
- Roan Kattouw (lead developer Sep 2007–2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (lead developer 2013–2020)
Please send your comments, suggestions and questions to [email protected] or file a bug report at https://phabricator.wikimedia.org/.