This is an auto-generated MediaWiki API documentation page.
Documentation and examples:
https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Huvudmodul
Status:
MediaWikis API ar ett moget och stabilt granssnitt som aktivt underhalls och forbattras. Vi forsoker undvika det men ibland behover vi kanske behover gora storande andringar; prenumerera pa
sandlistan mediawiki-api-announce
for uppdateringsaviseringar.
Felaktiga begaran:
Nar felaktiga begaran skickas till API:et kommer en HTTP-header skickas med nyckeln "MediaWiki-API-Error" och sedan kommer bade vardet i headern och felkoden som skickades tillbaka anges som samma varde. For mer information se
API: Fel och varningar
.
Testning:
For enkelt testning av API-begaran, se
Special:ApiSandbox
.
Parametrar:
- action
Vilken atgard som ska utforas.
- abusefiltercheckmatch
- Kontrollera om ett missbruksfilter matchar en grupp variabler, en redigering eller en handelse som ar loggad i missbruksfiltret.
- abusefilterchecksyntax
- Kontrollera syntaxen for ett missbruksfilter.
- abusefilterevalexpression
- Utvarderar uttryck i ett missbruksfilter.
- abusefilterunblockautopromote
- Upphaver blockering for en anvandare fran att fa automatiska befordringar p.g.a. konsekvenser fran ett missbruksfilter.
- abuselogprivatedetails
- Visa privata detaljer for 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 anvandarnamn mot AntiSpoofs normaliseringskontroller.
- block
- Blockera en anvandare.
- centralauthtoken
- Hamta en centralauthtoken for att gora en autentiserad begaran till en ansluten wiki.
- centralnoticecdncacheupdatebanner
- Begar rensning av bannerinnehall lagrat i CDN (front-end) cache for anonyma anvandare, for den begarda bannern och spraket
- centralnoticechoicedata
- Fa information som behovs for att valja en banner for ett visst projekt och sprak
- centralnoticequerycampaign
- Fa alla konfigurationsinstallningar for en kampanj.
- changeauthenticationdata
- Andra autentiseringsdata for aktuell anvandare.
- changecontentmodel
- Andra innehallsmodellen for en sida
- checktoken
- Kontrollera giltigheten av en nyckel fran
action=query&meta=tokens
.
- cirrus-config-dump
- Dump av CirrusSearch-konfiguration.
- cirrus-mapping-dump
- Dump av CirrusSearch-mappning for denna wiki.
- cirrus-profiles-dump
- Dump av CirrusSearch-profiler for denna wiki.
- cirrus-settings-dump
- Dumpa av CirrusSearch-installningar for denna wiki.
- clearhasmsg
- Rensa
hasmsg
-flaggan for den aktuella anvandaren.
- clientlogin
- Logga till pa wikin med det interaktiva flodet.
- compare
- Hamta skillnaden mellan tva sidor.
- createaccount
- Skapa ett nytt anvandarkonto.
- createlocalaccount
- Tvinga skapa ett lokalt konto
- cxdelete
- Radera ett oversattningsutkast som skapats med hjalp av tillagget Innehallsoversattning.
- cxsuggestionlist
- Hantera forslagslistor. Lagg till forslag i listor och ta bort dem.
- cxtoken
- Hamta JWT-nyckel for att autentisera med cxserver.
- delete
- Radera en sida.
- deleteglobalaccount
- Radera en global anvandare.
- discussiontoolsedit
- Posta ett inlagg pa en diskussionssida.
- discussiontoolsfindcomment
- Hitta en kommentar via dess ID eller namn.
- discussiontoolsgetsubscriptions
- Hamta prenumerationsstatus for angivna amnen.
- discussiontoolssubscribe
- Prenumerera (eller sluta prenumerera) for att ta emot aviseringar om ett amne.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Manually trigger a notification to a user
- echomarkread
- Markera aviseringar som lasta for den aktuella anvandaren.
- echomarkseen
- Mark aviseringar som lasta for aktuell anvandare.
- echomute
- Tysta eller sluta tysta aviseringar fran vissa anvandare eller sidor.
- edit
- Skapa och redigera sidor.
- editmassmessagelist
- Redigera leveranslista for massmeddelanden
- emailuser
- Skicka e-post till en anvandare.
- expandtemplates
- Expanderar alla mallar inom wikitext.
- featuredfeed
- Returnerar ett flode for utvalt innehall.
- feedcontributions
- Returnerar en anvandares bidragsflode.
- feedrecentchanges
- Returnerar ett flode med senaste andringar.
- feedwatchlist
- Returnerar ett flode fran bevakningslistan.
- filerevert
- Aterstall en fil till en aldre version.
- flow
- Gor det mojligt att utfora atgarder pa Structured Discussions-sidor.
- flow-parsoid-utils
- Konvertera text mellan wikitext och HTML.
- flowthank
- Skicka en offentlig tack-avisering for en Flow-kommentar.
- globalblock
- Blockera eller avblockera en anvandare globalt.
- globalpreferenceoverrides
- Andra lokala asidosattanden for globala installningar till nuvarande anvandare.
- globalpreferences
- Andra globala installningar for nuvarande anvandare.
- globaluserrights
- Lagg till/ta bort en anvandare till/fran 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
- Satt anvandares fadder. Andringen loggas offentligt.
- growthstarmentee
- Markera eller avmarkera en nyborjare som stjarnmarkt av nuvarande anvandare (lagras privat och loggas inte)
- help
- Visa hjalp for de angivna modulerna.
- homepagequestionstore
- Hamta formaterade fragor stallda via hemsidemoduler
- imagerotate
- Denna modul har inaktiverats.
- import
- Importer en sida fran en annan wiki eller fran en XML-fil.
- jsonconfig
- Tillater direkt tillgang till JsonConfigs undersystem
- languagesearch
- Sok efter spraknamn i valfritt skriftsystem.
- linkaccount
- Lanka ett konto fran en tredjepartsleverantor till nuvarande anvandare.
- login
- Logga in och hamta autentiseringskakor.
- logout
- Logga ut och rensa sessionsdata.
- managetags
- Utfor hanterings uppgifter relaterade till forandrings taggar.
- massmessage
- Skicka ett meddelande till en lista over sidor.
- mergehistory
- Sammanfoga sidhistoriker.
- move
- Flytta en sida.
- opensearch
- Sok wikin med protokollet OpenSearch.
- options
- Andra installningar for nuvarande anvandare.
- paraminfo
- Fa information om API moduler.
- parse
- Parses content and returns parser output.
- patrol
- Patrullera en sida eller en version.
- protect
- Andra skyddsnivan for en sida.
- purge
- Rensa cachen for 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 aterstall sidversioner.
- rollback
- Angra den senaste redigeringen pa sidan.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setglobalaccountstatus
- Andra en global anvandares status.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Andra spraket pa en sida.
- shortenurl
- Korta ner en lang URL till en kortare.
- sitematrix
- Hamta Wikimedia sidlistor.
- spamblacklist
- Validera en eller mer URL:er mot spamblockeringslistan.
- streamconfigs
- Visar konfiguration for handelsestrom. Aterkommer endast format=json med formatversion=2.
- strikevote
- Tillater administratorer att sla eller avbryta en omrostning.
- sxdelete
- Radera oversattningen av utkastsavsnittet och dess parallella korpus fran databasen.
- tag
- Lagg till eller ta bort andringsmarken fran individuella sidversioner eller loggposter.
- templatedata
- Hamta data som lagras av TemplateData-tillagget.
- thank
- Skicka ett tack-avisering till en redigerare.
- titleblacklist
- Validera en sidtitel, filnamn eller anvandare mot TitleBlacklist.
- torblock
- Check if an IP address is blocked as a Tor exit node.
- transcodereset
- Anvandare med "transcode-reset"-rattigheten kan aterstalla och kora om ett transkodningsjobb.
- unblock
- Upphav en anvandares blockering.
- undelete
- Aterstall sidversioner for en raderad sida.
- unlinkaccount
- Ta bort ett lankat tredjepartskonto fran aktuell anvandare.
- upload
- Ladda upp en fil eller hamta status for vantande uppladdningar.
- userrights
- Andra en anvandares gruppmedlemskap.
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- Lagg till eller ta bort sidor fran aktuell anvandares 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 anvandare.
- bouncehandler
- Intern.
Fa ett studsat e-post meddelande och bearbeta detta for att hantera den misslyckade mottagaren.
- categorytree
- Intern.
Intern modul for tillagget 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 tillagget for innehallsoversattning.
- cxpublishsection
- Intern.
Spara ett avsnitt som skapades med avsnittsoversattningsfunktionen i tillagget Innehallsoversattning.
- cxsave
- Intern.
Denna modul later oversattningsutkast sparas efter avsnitt for att spara bandbredd och for 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.
Fa information om kommentarsandringar mellan tva sidversioner.
- discussiontoolspageinfo
- Intern.
Returnerar metadata som kravs for att initialisera diskussionsverktygen.
- discussiontoolspreview
- Intern.
Forhandsgranska ett meddelande pa en diskussionssida.
- echopushsubscriptions
- Intern.
Hantera push-prenumerationer for nuvarande anvandare.
- editcheckreferenceurl
- Intern.
Check the status of a URL for use as a reference.
- fancycaptchareload
- Intern.
Hamta 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 fragor som laggs upp via hjalppanelen for nuvarande anvandare.
- jsondata
- Intern.
Hamta lokaliserad JSON-data.
- oathvalidate
- Intern.
Bekrafta en nyckel for tvafaktorsautentisering (OATH).
- parser-migration
- Intern.
Parse a page with two different parser configurations.
- readinglists
- Intern.
Skrivoperationer for laslistor.
- sanitize-mapdata
- Intern.
Utfor datavalidering for tillagget Kartographer
- scribunto-console
- Intern.
Intern modul for att betjana XHR-forfragningar fran 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 oversattningsskiss for avsnittet och lagra den parallella texten
- timedtext
- Intern.
Tillhandahaller tajmad textinnehall for anvandande av <track> elements
- ulslocalization
- Intern.
Fa lokalanpassningen av ULS pa ett visst sprak.
- ulssetlang
- Intern.
Uppdatera det sprak som anvandaren valt for granssnittet.
- visualeditor
- Intern.
Returnerar HTML5 for en sida fran Parsoid-tjansten.
- visualeditoredit
- Intern.
Spara en HTML5-sida till MediaWiki (konverterad till wikitext via Parsoid-tjansten).
- wikimediaeventsblockededit
- Intern.
Log information about blocked edit attempts
- Ett av foljande varden:
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 for 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 foljande varden:
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 headervardet
s-maxage
till sa har manga sekunder. Fel cachelagras aldrig.
- Type: integer
- The value must be no less than 0.
- Default: 0
- maxage
Ange headervardet
max-age
till sa har manga sekunder. Fel cachelagras aldrig.
- Type: integer
- The value must be no less than 0.
- Default: 0
- assert
Bekrafta att anvandaren ar inloggad om satt till
user
,
inte
inloggad om satt till
anon
,eller har bot-anvandarrattigheten om satt till
bot
.
- Ett av foljande varden: anon, bot, user
- assertuser
Verifiera att den nuvarande anvandaren ar den namngivne anvandaren.
- Typ: anvandare, genom nagot av anvandarnamn och Tillfallig anvandare
- requestid
Alla varde som anges har kommer att inkluderas i svaret. Kan anvandas for att sarskilja forfragningar.
- servedby
Inkludera det vardnamn som besvarade forfragan i resultatet.
- Type: boolean (
details
)
- curtimestamp
Inkludera den aktuella tidsstampeln i resultatet.
- Type: boolean (
details
)
- responselanginfo
Inkluderar de sprak som anvands for
uselang
och
errorlang
i resultatet.
- Type: boolean (
details
)
- origin
Nar API:et anvands genom en cross-domain AJAX-begaran (CORS), ange detta till den ursprungliga domanen. Detta maste inkluderas i alla pre-flight-begaran, och mpste darfor vara en del av den begarda URI:n (inte i POST-datat). Detta maste overensstamma med en av kallorna i headern
Origin
exakt, sa den maste sattas till nagot i stil med
http://en.wikipedia.org
eller
https://meta.wikimedia.org
. Om denna parameter inte overensstammer med headern
Origin
, returneras ett 403-svar. Om denna parameter overensstammer med headern
Origin
och kallan ar vitlistad, satts en
Access-Control-Allow-Origin
-header.
- uselang
Sprak som ska anvandas for meddelandeoversattningar.
action=query&meta=siteinfo
med
siprop=languages
returnerar en lista med sprakkoder, eller ange
user
for att anvanda den aktuella anvandarens sprakpreferenser, eller ange
content
for att anvanda innehallsspraket.
- 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 foljande varden: bc, html, none, plaintext, raw, wikitext
- Default: bc
- errorlang
Sprak att anvanda for varningar och fel.
action=query&meta=siteinfo
med
siprop=languages
returnerar en lista over sprakkoder eller specifikt
content
for att anvanda innehallsspraket pa denna wiki, eller specifikt
uselang
for att anvanda samma varde som parametern
uselang
.
- Default: uselang
- errorsuselocal
Om angivet kommer feltexter att anvanda lokalt anpassade meddelande fran namnrymden MediaWiki.
- Type: boolean (
details
)
- centralauthtoken
Nar du anvander API:et med en AJAX-begaran (CORS) over flera domaner kan du anvanda detta for att autentisera som den aktuella SUL-anvandaren. Anvand
action=centralauthtoken
pa denna wiki for att hamta tecken innan du gor CORS-begaran. Varje tecken far endast anvandas en gang och gar ut efter 10 sekunder. Detta bor inga i alla forfragningar fore flygning och bor darfor inga i URI begaran (inte POST-body).
Permissions:
- writeapi
- Anvanda skriv-API:et
- Granted to: all, user och bot
- 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 och sysop
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
-
15
T
14
:
56
:
00
Z
. 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 mediawiki-api@lists.wikimedia.org
or file a bug report at
https://phabricator.wikimedia.org/
.