עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API
יחידה ראשית
- מקור: MediaWiki
- רישיון: GPL-2.0+
מצב: כל האפשרויות שמוצגות בדף הזה אמורות לעבוד, אבל ה־API עדיין בפיתוח פעיל, ויכול להשתנות בכל זמן. עשו מינוי לרשימת הדיוור mediawiki-api-announce להודעות על עדכונים.
בקשות שגויות: כשבקשות שגויות נשלחות ל־API, תישלח כותרת HTTP עם המפתח "MediaWiki-API-Error" ואז גם הערך של הכותרת וגם קוד השגיאה יוגדרו לאותו ערך. למידע נוסף ר' API: שגיאות ואזהרות.
בדיקה: לבדיקה קלה יותר של בקשות ר' Special:ApiSandbox.
- action
איזו פעולה לבצע.
- אחד מהערכים הבאים: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch
- ברירת מחדל: help
- format
תסדיר הפלט.
- אחד מהערכים הבאים: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- ברירת מחדל: jsonfm
- maxlag
שיהוי מרבי יכול לשמש כשמדיה־ויקי מותקנת בצביר עם מסד נתונים משוכפל. כדי לחסוך בפעולות שגורמות יותר שיהוי בשכפול אתר, הפרמטר הזה יכול לגרום ללקוח להמתין עד ששיהוי השכפול יורד מתחת לערך שצוין. במקרה של שיהוי מוגזם, קוד השגיאה maxlag מוחזר עם הודעה כמו Waiting for $host: $lag seconds lagged.
ר' מדריך למשתמש: פרמטר maxlag למידע נוסף.- סוג: מספר שלם
- smaxage
הגדרת כותרת בקרת מטמון HTTP
s-maxageלמספר כזה של שניות.- סוג: מספר שלם
- ברירת מחדל: 0
- maxage
הגדרת כותרת בקרת מטמון HTTP
max-ageלמספר כזה של שניות.- סוג: מספר שלם
- ברירת מחדל: 0
- assert
לוודא שהמשתמש נכנס אם זה מוגדר ל־user, או שיש לו הרשאת בוט אם זה bot.
- אחד מהערכים הבאים: user, bot
- assertuser
לוודא שהמשתמש הנוכחי הוא המשתמש ששמו ניתן.
- סוג: שם משתמש
- requestid
כל ערך שיינתן כאן ייכלל בתשובה. אפשר להשתמש בזה כדי להבדיל בין בקשות.
- servedby
לכלול את שם המארח ששירת את הבקשה בתוצאות.
- סוג: בוליאני (פרטים)
- curtimestamp
הכללת חותם־הזמן הנוכחי בתוצאה.
- סוג: בוליאני (פרטים)
- responselanginfo
לכלול את השפות שמשמשות ל־uselang ול־errorlang בתוצאה.
- סוג: בוליאני (פרטים)
- origin
בעת גישה ל־API עם בקשת AJAX חוצה מתחמים (CORS), יש להציב כאן את המתחם שהבקשה יוצאת ממנו. זה היה להיות כלול בכל בקשה מקדימה, ולכן הוא חייב להיות חלק מה־URI של הבקשה (לא גוף ה־POST).
עבור בקשות מאומתות, זה חייב להיות תואם במדויק לאחד המקורות בכותרת
Origin, כך שזה צריך להיות מוגדר למשהו כמו https://en.wikipedia.org או https://meta.wikimedia.org. אם הפרמטר הזה אינו תואם לכותרתOrigin, תוחזר תשובת 403. אם הפרמטר הזה תורם לכותרתOriginוהמקור נמצא ברשימה הלבנה, תוגדרנה הכותרותAccess-Control-Allow-Originו־Access-Control-Allow-Credentials.עבור בקשות בלתי־מאומתות, יש לציין את הערך *. זה יגרום לכותרת להיות
Access-Control-Allow-Origin, אבלAccess-Control-Allow-Credentialsתהיהfalseוכל הנתונים הייחודיים למשתמש יהיו מוגבלים.- uselang
באיזו שפה להשתמש לתרגומי הודעות. הקריאה action=query&meta=siteinfo עם siprop=languages מחזירה רשימת קודים. ציון user כדי להשתמש בהעדפת השפה של המשתמש הנוכחי, וציון content להשתמש בקוד השפה של הוויקי הזה.
- ברירת מחדל: user
- errorformat
תסדיר לשימוש בפלט טקסט אזהרות ושגיאות.
- plaintext
- קוד ויקי ללא תגי HTML ועם ישויות מוחלפות.
- wikitext
- קוד ויקי לא מפוענח.
- html
- קוד HTML.
- raw
- מפתח הודעה ופרמטרים.
- none
- ללא פלט טקסט, רק הודעות השגיאה.
- bc
- התסדיר ששימש לפני מדיה־ויקי 1.29. התעלמות מ־errorlang ו־ errorsuselocal.
- אחד מהערכים הבאים: plaintext, wikitext, html, raw, none, bc
- ברירת מחדל: bc
- errorlang
השפה שתשמש לאזהרות לשגיאות action=query&meta=siteinfo עם siprop=languages תחזיר רשימת קודי שפה, ואפשר גם לציין content כדי להשתמש בשפת התוכן של הוויקי הזה, או לציין uselang עם אותו הערך הפרמטר uselang.
- ברירת מחדל: uselang
- errorsuselocal
אם ניתן, הטקסטים של השגיאות ישתמשו בהודעות מותאמות מקומית ממרחב השם מדיה ויקי.
- סוג: בוליאני (פרטים)
- עזרה ליחידה הראשית.
- api.php?action=help [פתיחה בארגז חול]
- כל העזרה בדף אחד.
- api.php?action=help&recursivesubmodules=1 [פתיחה בארגז חול]
action=block
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
חסימת משתמש.
- user
שם משתמש, כתובת IP, או טווח כתובות IP שברצונך לחסום. אי־אפשר להשתמש בזה יחד עם userid
- סוג: שם משתמש
- userid
מזהה המשתמש לחסימה. לא יכול לשמש יחד עם user.
- סוג: מספר שלם
- expiry
זמן תפוגה. יכול להיות יחסי (למשל 5 months או 2 weeks) או מוחלט (למשל 2014-09-18T12:34:56Z). אם זה מוגדר ל־infinite, indefinite, או never, החסימה לא תפוג לעולם.
- ברירת מחדל: never
- reason
סיבה לחסימה.
- ברירת מחדל: (ריק)
- anononly
לחסום משתמשים אלמוניים בלבד (דהיינו, השבתת עריכות אלמוניות מכתובת ה־IP הזאת)
- סוג: בוליאני (פרטים)
- nocreate
מניעת יצירת חשבונות
- סוג: בוליאני (פרטים)
- autoblock
חסימה אוטומטית גם של כתובת ה־IP האחרונה שהשתמש בה ושל כל כתובת IP שינסה להשתמש בה בעתיד.
- סוג: בוליאני (פרטים)
- noemail
למנוע ממשתמש לשלוח דואר אלקטרוני דרך הוויקי. (דורש את ההרשאה
blockemail).- סוג: בוליאני (פרטים)
- hidename
הסרת השם מיומן החסימות. (דורש את ההרשאה
hideuser.)- סוג: בוליאני (פרטים)
- allowusertalk
לאפשר למשתמש לערוך את דף השיחה שלו או שלה (תלוי ב־$wgBlockAllowsUTEdit).
- סוג: בוליאני (פרטים)
- reblock
אם המשתמש כבר חסום, לדרוס את החסימה הנוכחית.
- סוג: בוליאני (פרטים)
- watchuser
לעקוב אחרי דף המשתמש ודף השיחה של המשתמש או של כתובת ה־IP.
- סוג: בוליאני (פרטים)
- tags
תגי שינוי שיחולו על העיול ביומן החסימה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- חסימת כתובת ה־IP 192.0.2.5 לשלושה ימים עם הסיבה First strike.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [פתיחה בארגז חול]
- חסימת המשתמש Vandal ללא הגבלת זמן עם הסיבה Vandalism, ומניעת יצירת חשבונות חדשים ושליחת דוא"ל.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [פתיחה בארגז חול]
action=changeauthenticationdata (changeauth)
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שינוי נתוני אימות עבור המשתמש הנוכחי.
- changeauthrequest
להשתמש בבקשת האימות הזאת, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=change.
- פרמטר זה נדרש.
- changeauthtoken
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- *
- המודול הזה מקבל פרמטרים נוספים בהתאם לבקשות אימות זמינות. יש להשתמש ב־action=query&meta=authmanagerinfo עם amirequestsfor=change (או תגובה קודמת מהמודול הזה, אם זה זמין) כדי להבין מה הבקשות הזמינות ובאילו שדות הן משתמשות.
- ניסיון לשנות את הססמה של המשתמש הנוכחי ל־ExamplePassword.
- api.php?action=changeauthenticationdata&changeauthrequest=MediaWiki%5CAuth%5CPasswordAuthenticationRequest&password=ExamplePassword&retype=ExamplePassword&changeauthtoken=123ABC [פתיחה בארגז חול]
action=checktoken
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
בדיקת התקינות של האסימון מ־action=query&meta=tokens.
- type
סוג האסימון שבבדיקה.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: createaccount, csrf, login, patrol, rollback, userrights, watch
- token
איזה אסימון לבדוק.
- פרמטר זה נדרש.
- maxtokenage
הגיל המרבי המותר של האסימון, בשניות.
- סוג: מספר שלם
- בדיקת התקינות של אסימון csrf.
- api.php?action=checktoken&type=csrf&token=123ABC [פתיחה בארגז חול]
action=clearhasmsg
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מנקה את דגל hasmsg עבור המשתמש הנוכחי.
- לנקות את דגל
hasmsgעבור המשתמש הנוכחי. - api.php?action=clearhasmsg [פתיחה בארגז חול]
action=clientlogin (login)
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
כניסה לוויקי באמצעות זרימה הידודית.
הנוהל הכללי לשימוש במודול הזה הוא:
- אחזור השדות הזמינים מ־action=query&meta=authmanagerinfo עם amirequestsfor=login ואסימון login מתוך action=query&meta=tokens.
- הצגת השדות למשתמש וקבלת אישור ממנו.
- שליחה (Post) למודול הזה עם loginreturnurl וכל השדות הרלוונטיים.
- בדיקת ה־status בתשובה.
- אם קיבלת PASS או FAIL, זה הסיום. הפעולה שלך הצליחה או נכשלה.
- אם קיבלת UI, יש להציג את השדות החדשים למשתמש ולקבל את מה שהוא ישלח. אחר־כך יש לשלוח (post) למודול הזה עם logincontinue ועם הגדרות של השדות הרלוונטיים ולחזור על צעד 4.
- אם קיבלת REDIRECT, יש להפנות את המשתמש ל־redirecttarget ולחכות לחזרה אל loginreturnurl. אחר־כך לשלוח (post) למודול הזה עם logincontinue ועם כל השדות שהועברו ל־URL שחוזרים אליו ולחזור על צעד 4.
- אם קיבלת RESTART, זה אומר שהאימות עבד אבל אין חשבון משתמש מקושר. באפשרותך לטפל בזה כמו ב־UI או ב־FAIL.
- loginrequests
להשתמש רק בבקשות האימות האלו, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=login או מתשובה קודמת למודול הזה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- loginmessageformat
תסדיר לשימוש בהחזרת הודעות.
- אחד מהערכים הבאים: html, wikitext, raw, none
- ברירת מחדל: wikitext
- loginmergerequestfields
מיזוג מידע של שדות עבור כל בקשות האימות למערך אחד.
- סוג: בוליאני (פרטים)
- loginpreservestate
שימור מצב מניסיון כניסה קודם, אם אפשר.
- סוג: בוליאני (פרטים)
- loginreturnurl
כתובת URL לחזרה עם זרימות אימות צד־שלישי, חייב להיות מוחלט. נדרש או זה או logincontinue.
עם קבלת תשובת REDIRECT, בדרך־כלל תפתח דפדפן או תצוגת וב בכתובת ה־redirecttarget שצוינה בשביל זרימת אימות צד־שלישי. כשזה יושלם, הצד השלישי ישלח את הדפדפן או את תצוגת הווב לכתובת הזאת. יש לחלץ את כל הפרמטרים של שאילתה או בקשת POST מה־URL ולהעביר אותם בתור בקשת logincontinue למודול ה־API הזה.
- logincontinue
הבקשה הזאת היא המשך אחרי תשובת UI או REDIRECT קודמת. נדרש זה או loginreturnurl.
- סוג: בוליאני (פרטים)
- logintoken
אסימון "login" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- *
- המודול הזה מקבל פרמטרים נוספים בהתאם לבקשות אימות זמינות. יש להשתמש ב־action=query&meta=authmanagerinfo עם amirequestsfor=login (או תגובה קודמת מהמודול הזה, אם זה זמין) כדי להבין מה הבקשות הזמינות ובאילו שדות הן משתמשות.
- תחילת תהליך כניסה לוויקי בתור משתמש Example עם הססמה ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [פתיחה בארגז חול]
- המשך כניסה אחרי תשובת UI לאימות דו־גורמי, עם OATHToken של 987654.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [פתיחה בארגז חול]
action=compare
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת ההבדל בין 2 דפים.
יש להעביר מספר גרסה, כותרת דף או מזהה דף גם ל־"from" וגם ל־"to".
- fromtitle
כותרת ראשונה להשוואה.
- fromid
מס׳ זיהוי של העמוד הראשון להשוואה.
- סוג: מספר שלם
- fromrev
גרסה ראשונה להשוואה.
- סוג: מספר שלם
- totitle
כותרת שנייה להשוואה.
- toid
מס׳ מזהה של העמוד השני להשוואה.
- סוג: מספר שלם
- torev
גרסה שנייה להשוואה.
- סוג: מספר שלם
- יצירת תיעוד שינוי בין גרסה 1 ל־2.
- api.php?action=compare&fromrev=1&torev=2 [פתיחה בארגז חול]
action=createaccount (create)
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
יצירת חשבון משתמש חדש.
הנוהל הכללי לשימוש במודול הזה הוא:
- אחזור השדות הזמינים מ־action=query&meta=authmanagerinfo עם amirequestsfor=create ואסימון createaccount מתוך action=query&meta=tokens.
- הצגת השדות למשתמש וקבלת אישור ממנו.
- שליחה (Post) למודול הזה עם createreturnurl וכל השדות הרלוונטיים.
- בדיקת ה־status בתשובה.
- אם קיבלת PASS או FAIL, זה הסיום. הפעולה שלך הצליחה או נכשלה.
- אם קיבלת UI, יש להציג את השדות החדשים למשתמש ולקבל את מה שהוא ישלח. אחר־כך יש לשלוח (post) למודול הזה עם createcontinue ועם הגדרות של השדות הרלוונטיים ולחזור על צעד 4.
- אם קיבלת REDIRECT, יש להפנות את המשתמש ל־redirecttarget ולחכות לחזרה אל createreturnurl. אחר־כך לשלוח (post) למודול הזה עם createcontinue ועם כל השדות שהועברו ל־URL שחוזרים אליו ולחזור על צעד 4.
- אם קיבלת RESTART, זה אומר שהאימות עבד אבל אין חשבון משתמש מקושר. באפשרותך לטפל בזה כמו ב־UI או ב־FAIL.
- createrequests
להשתמש רק בבקשות האימות האלו, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=create או מתשובה קודמת למודול הזה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- createmessageformat
תסדיר לשימוש בהחזרת הודעות.
- אחד מהערכים הבאים: html, wikitext, raw, none
- ברירת מחדל: wikitext
- createmergerequestfields
מיזוג מידע של שדות עבור כל בקשות האימות למערך אחד.
- סוג: בוליאני (פרטים)
- createpreservestate
שימור מצב מניסיון כניסה קודם, אם אפשר.
אם action=query&meta=authmanagerinfo החזיר true עבור hasprimarypreservedstate, בקשות שמסומנות בתור primary-required אמורות להיות מושמטות. אם מוחזר ערך לא ריק ל־preservedusername, שם המשתמש הזה ישמש לפרמטר username.
- סוג: בוליאני (פרטים)
- createreturnurl
כתובת URL לחזרה עם זרימות אימות צד־שלישי, חייב להיות מוחלט. נדרש או זה או createcontinue.
עם קבלת תשובת REDIRECT, בדרך־כלל תפתח דפדפן או תצוגת וב בכתובת ה־redirecttarget שצוינה בשביל זרימת אימות צד־שלישי. כשזה יושלם, הצד השלישי ישלח את הדפדפן או את תצוגת הווב לכתובת הזאת. יש לחלץ את כל הפרמטרים של שאילתה או בקשת POST מה־URL ולהעביר אותם בתור בקשת createcontinue למודול ה־API הזה.
- createcontinue
הבקשה הזאת היא המשך אחרי תשובת UI או REDIRECT קודמת. נדרש זה או createreturnurl.
- סוג: בוליאני (פרטים)
- createtoken
אסימון "createaccount" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- *
- המודול הזה מקבל פרמטרים נוספים בהתאם לבקשות אימות זמינות. יש להשתמש ב־action=query&meta=authmanagerinfo עם amirequestsfor=create (או תגובה קודמת מהמודול הזה, אם זה זמין) כדי להבין מה הבקשות הזמינות ובאילו שדות הן משתמשות.
- תחילת תהליך יצירת המשתמש Example עם הססמה ExamplePassword.
- api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC [פתיחה בארגז חול]
action=cspreport
- היחידה הזאת היא פנימית או בלתי־יציבה. הפעולה שלה יכולה להשתנות ללא הודעה מוקדמת.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
משמש דפדפנים לדיווח הפרות של מדיניות אבטחת תוכן. המודול הזה לעולם לא ישמש אלא אם הוא משמש עם דפדפן תומך CSP.
- reportonly
לסמן בתור דיווח ממדיניות מנטרת, לא מדיניות כפויה
- סוג: בוליאני (פרטים)
- source
מה ייצר את כותרת ה־CSP שייצרה את הדו״ח הזה
- ברירת מחדל: internal
action=delete
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מחיקת דף.
- title
כותרת העמוד למחיקה. לא ניתן להשתמש בשילוב עם pageid.
- pageid
מס׳ הזיהוי של העמוד למחיקה. לא ניתן להשתמש בשילוב עם title.
- סוג: מספר שלם
- reason
סיבת המחיקה. אם לא הוגדרה, תתווסף סיבה שנוצרה אוטומטית.
- tags
תגי שינוי שיחולו על העיול ביומן המחיקה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- watch
- מיושן.
הוספת העמוד לרשימת המעקב של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- watchlist
הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.
- אחד מהערכים הבאים: watch, unwatch, preferences, nochange
- ברירת מחדל: preferences
- unwatch
- מיושן.
הסרת הדף מרשימת המעקב של של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- oldimage
שם התמונה הישנה למחיקה כפי שסופק ל־action=query&prop=imageinfo&iiprop=archivename.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- מחיקת Main Page.
- api.php?action=delete&title=Main%20Page&token=123ABC [פתיחה בארגז חול]
- מחיקת Main Page. סיבה: Preparing for move.
- api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move [פתיחה בארגז חול]
action=edit
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
יצירה ועריכה של דפים.
- title
שם הדף לעריכה. לא לשימוש עם pageid.
- pageid
מזהה הדף לעריכה. לא לשימוש עם title.
- סוג: מספר שלם
- section
מספר הפסקה 0 לפסקה העליונה, new לפסקה חדשה.
- sectiontitle
הכותרת לפסקה החדשה.
- text
תוכן הדף.
- summary
תקציר עריכה. גם כותרת פסקה כש־section=new ו־sectiontitle אינו מוגדר.
- tags
אילו תגי שינוי להחיל על הגרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- minor
עריכה משנית.
- סוג: בוליאני (פרטים)
- notminor
שינוי לא משני.
- סוג: בוליאני (פרטים)
- bot
סימון עריכה זו כעריכת בוט.
- סוג: בוליאני (פרטים)
- basetimestamp
חותם־זמן של גרסת הבסיס, משמש לזיהוי התנגשויות עריכה. אפשר לקבל אותו באמצעות action=query&prop=revisions&rvprop=timestamp.
- סוג: חותם־זמן (תסדירים מורשים)
- starttimestamp
חותם־הזמן של תחילת תהליך העריכה, משמש לזיהוי התנגשויות. אפשר לקבל ערך מתאים באמצעות curtimestamp בעת תחילת תהליך העריכה (למשל בזמן טעינת תוכן הדף לעריכה).
- סוג: חותם־זמן (תסדירים מורשים)
- recreate
לעקוב את כל הטעויות על כך שהדף נמחק בינתיים.
- סוג: בוליאני (פרטים)
- createonly
לא לערוך את הדף אם הוא כבר קיים.
- סוג: בוליאני (פרטים)
- nocreate
לזרוק שגיאה אם הדף אינו קיים.
- סוג: בוליאני (פרטים)
- watch
- מיושן.
הוספת העמוד לרשימת המעקב של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- unwatch
- מיושן.
הסרת הדף מרשימת המעקב של של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- watchlist
להוסיף את הדף לרשימת המעקב של המשתמש הנוכחי או להסיר אותו משם, להשתמש בהעדפות, או לא לשנות את מצב המעקב.
- אחד מהערכים הבאים: watch, unwatch, preferences, nochange
- ברירת מחדל: preferences
- md5
גיבוב MD5 של הפרמטר text או צירוף של הפטמטרים prependtext ו־appendtext. אם זה מוגדר, העריכה לא תיעשה אלא אם כן הגיבוב נכון.
- prependtext
הוספת הטקסט הזה לתחילת הדף. דורס את text.
- appendtext
הוספת הטקסט הזה לסוף הדף. דורס את text.
יש להשתמש ב־section=new כדי להוסיף פסקה חדשה, ולא בפרמטר הזה.
- undo
לבטל את הגרסה הזאת. דורס את text, prependtext ו־appendtext.
- סוג: מספר שלם
- undoafter
ביטול כל הגרסאות מ־undo עד כאן. אם זה לא מוגדר, לבטל רק גרסה אחת.
- סוג: מספר שלם
- redirect
לפתור הפניות אוטומטית.
- סוג: בוליאני (פרטים)
- contentformat
תסדיר להסדרת תוכן שמשמש את טקסט הקלט.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- contentmodel
מודל התוכן של התוכן החדש.
- אחד מהערכים הבאים: wikitext, javascript, json, css, text
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
האסימון תמיד צריך להישלח בתור הפרמטר האחרון, או לפחות אחרי הפרמטר text parameter.
- פרמטר זה נדרש.
- עריכת דף
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [פתיחה בארגז חול]
- הוספת __NOTOC__ לתחילת העמוד.
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [פתיחה בארגז חול]
- ביטול גרסאות מ־13579 עד 13585 עם תקציר אוטומטי.
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [פתיחה בארגז חול]
action=emailuser
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שליחת דוא"ל למשתמש.
- target
לאיזה משתמש לשלוח דוא"ל.
- פרמטר זה נדרש.
- subject
כותרת נושא.
- text
גוף הדואר.
- פרמטר זה נדרש.
- ccme
שליחת עותק של הדואר הזה אליי.
- סוג: בוליאני (פרטים)
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- שליחת דוא"ל למשתמש WikiSysop עם הטקסט Content.
- api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [פתיחה בארגז חול]
action=expandtemplates
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
הרחבת כל התבניות בתוך קוד הוויקי.
- title
כותרת הדף.
- ברירת מחדל: API
- text
איזה קוד ויקי להמיר.
- פרמטר זה נדרש.
- revid
מזהה גרסה, עבור {{REVISIONID}} ומשתנים דומים.
- סוג: מספר שלם
- prop
אילו חלקי מידע לקבל.
יש לשים לכך שאם לא נבחרו ערכים, התוצאה תכיל את קוד הוויקי, אבל הפלט יהיה בתסדיר מיושן.
- wikitext
- קוד הוויקי המורחב.
- categories
- קטגוריות כלשהן שקיימות בקלט ואינן מיוצגות בפלט הוויקיטקסט.
- properties
- מאפייני דף המוגדרים במילות קסם מורחבות בקוד ויקי.
- volatile
- האם הפלט הוא נדיף ואין להשתמש בו במקום אחר בעמוד.
- ttl
- הזמן המרבי שאחריו המטמונים של התוצאה צריכים לפוג.
- modules
- כל יחידות ה־ResourceLoader שפונקציות מפענח ביקשו לוסיף לפלט. יש לבקש את jsconfigvars או את encodedjsconfigvars יחד עם modules.
- jsconfigvars
- נותן משתני הגדרות של JavaScript שייחודיים לדף הזה.
- encodedjsconfigvars
- נותן משתני הגדרות של JavaScript שייחודיים לדף הזה בתור מחרוזת JSON.
- parsetree
- עץ פענוח XML של הקלט.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree
- includecomments
האם לכלול הערות HTML בפלט.
- סוג: בוליאני (פרטים)
- generatexml
- מיושן.
יצירת עץ פענוח XML (מוחלף ב־prop=parsetree).
- סוג: בוליאני (פרטים)
- להרחיב את קוד הוויקי {{Project:Sandbox}}.
- api.php?action=expandtemplates&text={{Project:Sandbox}} [פתיחה בארגז חול]
action=feedcontributions
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
להחזיר הזנת תרומות משתמש.
- feedformat
תסדיר ההזנה.
- אחד מהערכים הבאים: rss, atom
- ברירת מחדל: rss
- user
לקבל תרומות של אילו משמשים.
- פרמטר זה נדרש.
- סוג: שם משתמש
- namespace
לפי איזה מרחב שם לסנן את התרומות.
- אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- year
החל משנה (ולפני כן).
- סוג: מספר שלם
- month
החל מחודש (ולפני כן).
- סוג: מספר שלם
- tagfilter
סינון תרומות בעלות התגיות הבאות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): mw-contentmodelchange
- ברירת מחדל: (ריק)
- deletedonly
הצגת תרומות שנמחקו בלבד.
- סוג: בוליאני (פרטים)
- toponly
הצגת עריכות שהן הגרסה העדכנית ביותר בלבד.
- סוג: בוליאני (פרטים)
- newonly
להציג רק עריכות שהן יצירות דפים.
- סוג: בוליאני (פרטים)
- hideminor
להסתיר עריכות משניות.
- סוג: בוליאני (פרטים)
- showsizediff
להציג את ההבדל בגודל בין גרסאות.
- סוג: בוליאני (פרטים)
- החזרת תרומות עבור המשתמש Example.
- api.php?action=feedcontributions&user=Example [פתיחה בארגז חול]
action=feedrecentchanges
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
להחזיר הזנת שינויים אחרונים.
- feedformat
תסדיר ההזנה.
- אחד מהערכים הבאים: rss, atom
- ברירת מחדל: rss
- namespace
לאיזה מרחב שם להגביל את התוצאות.
- אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- invert
כל מרחבי השם למעט זה שנבחר.
- סוג: בוליאני (פרטים)
- associated
לכלול מרחב שם משויך (שיחה או ראשי).
- סוג: בוליאני (פרטים)
- days
לכמה ימים להגביל את התוצאות.
- הערך לא יכולים להיות קטנים מ־1.
- סוג: מספר שלם
- ברירת מחדל: 7
- limit
המספר המרבי של התוצאות להחזיר.
- הערך חייב להיות בין 1 ל־50.
- סוג: מספר שלם
- ברירת מחדל: 50
- from
להציג תוצאות מאז.
- סוג: חותם־זמן (תסדירים מורשים)
- hideminor
הסתרת שינוים משניים.
- סוג: בוליאני (פרטים)
- hidebots
הסתרת שינויים שנעשו על ידי בוטים.
- סוג: בוליאני (פרטים)
- hideanons
הסתרת שינויים שנעשו על ידי אנונימים.
- סוג: בוליאני (פרטים)
- hideliu
הסתרת שינויים שנעשו על ידי משתמשים רשומים.
- סוג: בוליאני (פרטים)
- hidepatrolled
הסתרת שינויים שנבדקו.
- סוג: בוליאני (פרטים)
- hidemyself
הסתרת שינוים שנעשו על ידי המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- hidecategorization
להסתיר שינויים בחברות בקטגוריה.
- סוג: בוליאני (פרטים)
- tagfilter
סינון לפי תגית.
- target
הצגת שינויים שנעשו בדפים המקושרים לדף זה בלבד.
- showlinkedto
להציג את השינויים בדפים שמקושרים לדף שנבחר במקום זה.
- סוג: בוליאני (פרטים)
- הצגת שינויים אחרונים.
- api.php?action=feedrecentchanges [פתיחה בארגז חול]
- הצגת שינויים אחרונים עבור 30 ימים.
- api.php?action=feedrecentchanges&days=30 [פתיחה בארגז חול]
action=feedwatchlist
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת הזנת רשימת מעקב.
- feedformat
תסדיר ההזנה.
- אחד מהערכים הבאים: rss, atom
- ברירת מחדל: rss
- hours
רשימת דפים ששונו בתוך מספר כזה של שעות מעכשיו.
- הערך חייב להיות בין 1 ל־72.
- סוג: מספר שלם
- ברירת מחדל: 24
- linktosections
לקשר ישר לפסקאות ששונו אם אפשר.
- סוג: בוליאני (פרטים)
- allrev
לכלול גרסאות מרובות של אותו הדף בתוך מסגרת הזמן הנתונה.
- סוג: בוליאני (פרטים)
- wlowner
משמש יחד עם token לגישה לרשימת מעקב של משתמש אחר.
- סוג: שם משתמש
- wltoken
אסימון אבטחה (זמין ב־העדפות) שמאפשר לגשת לרשימת מעקב של משתמש אחר.
- wlshow
הצגה רק של פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק עריכות משניות שעשו משתמשים שנכנסו לחשבון, יש להגדיר show=minor|!anon.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread
- wltype
אולי סוגי שינויים להציג:
- edit
- עריכות דף רגילות.
- new
- יצירות דף.
- log
- עיולי יומן.
- external
- שינויים חיצוניים.
- categorize
- שינויים בהשתייכות לקטגוריה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): edit, new, log, external, categorize
- ברירת מחדל: edit|new|log|categorize
- wlexcludeuser
Don't list changes by this user
- סוג: שם משתמש
- הצגת הזנת רשימת מעקב.
- api.php?action=feedwatchlist [פתיחה בארגז חול]
- להציג את כל השינויים בדפים שבמעקב ב־6 השעות האחרונות.
- api.php?action=feedwatchlist&allrev=&hours=6 [פתיחה בארגז חול]
action=filerevert
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לשחזר את הקובץ לגרסה ישנה יותר.
- filename
שם קובץ היעד, ללא התחילית File:.
- פרמטר זה נדרש.
- comment
הערת העלאה.
- ברירת מחדל: (ריק)
- archivename
שם הארכיון של הגרסה שאליה ישוחזר הקובץ.
- פרמטר זה נדרש.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לשחזר את Wiki.png לגרסה מ־2011-03-05T15:27:40Z.
- api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC [פתיחה בארגז חול]
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC){kind=link}
action=help
- מקור: MediaWiki
- רישיון: GPL-2.0+
הצגת עזרה עבור היחידות שצוינו.
- modules
עזרה של אילו יחידות להציג (ערכים של הפרמטרים action ו־format, או main). אפשר להגדיר תת־יחידות עם +.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ברירת מחדל: main
- submodules
לכלול עזרה לתת־יחידות ליחידה שצוינה.
- סוג: בוליאני (פרטים)
- recursivesubmodules
לכלול עזרה לתת־יחידות באופן רקורסיבי.
- סוג: בוליאני (פרטים)
- wrap
לעטוף את הפלט במבנה תשובת API תקני.
- סוג: בוליאני (פרטים)
- toc
לכלול תוכן עניינים בפלט HTML.
- סוג: בוליאני (פרטים)
- עזרה ליחידה הראשית.
- api.php?action=help [פתיחה בארגז חול]
- עזרה עבור action=query וכל התת־מודולים שלו.
- api.php?action=help&modules=query&submodules=1 [פתיחה בארגז חול]
- כל העזרה בדף אחד.
- api.php?action=help&recursivesubmodules=1 [פתיחה בארגז חול]
- עזרה ליחידת העזרה עצמה.
- api.php?action=help&modules=help [פתיחה בארגז חול]
- עזרה לשתי תת־יחידות של שאילתה.
- api.php?action=help&modules=query+info|query+categorymembers [פתיחה בארגז חול]
action=imagerotate
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
סיבוב של תמונה אחת או יותר.
- rotation
בכמה מעלות לסובב בכיוון השעון.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: 90, 180, 270
- continue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- tags
אילו תגים להחיל על העיול ביומן ההעלאות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- titles
רשימת כותרות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pageids
רשימת מזהי דף לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- revids
רשימת מזהי גרסה לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- generator
קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.
לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz וגם zh.
- סוג: בוליאני (פרטים)
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לסובב את File:Example.png ב־90 מעלות.
- api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC [פתיחה בארגז חול]
- לסובב את כל התמונות ב־Category:Flip ב־180 מעלות.
- api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC [פתיחה בארגז חול]
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC){kind=link}
action=import
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לייבא דף מוויקי אחר או מקובץ XML.
יש לשים לב לכך שפעולת HTTP POST צריכה להיעשות בתור העלאת קובץ (כלומר, עם multipart/form-data) בזמן שליחת קובץ לפרמטר xml.
- summary
תקציר ייבוא עיולי יומן.
- xml
קובץ XML שהועלה.
- חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
- interwikisource
ליבוא בין אתרי ויקי: מאיזה ויקי לייבא.
- אחד מהערכים הבאים:
- interwikipage
ליבוא בין אתרי ויקי: איזה דף לייבא.
- fullhistory
ליבוא בין אתרי ויקי: לייבר את ההיסטוריה המלאה, לא רק את הגרסה הנוכחית.
- סוג: בוליאני (פרטים)
- templates
ליבוא בין אתרי ויקי: לייבא גם את כל התבניות המוכללות.
- סוג: בוליאני (פרטים)
- namespace
לייבא למרחב השם הזה. לא ניתן להשתמש בזה יחד עם rootpage.
- אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- rootpage
לייבא בתור תת־משנה של הדף הזה. לא ניתן להשתמש בזה יחד עם namespace.
- tags
תגי שינוי שיחולו על העיול ביומן הייבוא ולגרסה הריקה בדפים המיובאים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לייבא את meta:Help:ParserFunctions למרחב השם 100 עם היסטוריה מלאה.
- api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC [פתיחה בארגז חול]
action=linkaccount (link)
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קישור חשבון של ספק צד־שלישי למשתמש הנוכחי.
הנוהל הכללי לשימוש במודול הזה הוא:
- אחזור השדות הזמינים מ־action=query&meta=authmanagerinfo עם amirequestsfor=link ואסימון csrf מתוך action=query&meta=tokens.
- הצגת השדות למשתמש וקבלת אישור ממנו.
- שליחה (Post) למודול הזה עם linkreturnurl וכל השדות הרלוונטיים.
- בדיקת ה־status בתשובה.
- אם קיבלת PASS או FAIL, זה הסיום. הפעולה שלך הצליחה או נכשלה.
- אם קיבלת UI, יש להציג את השדות החדשים למשתמש ולקבל את מה שהוא ישלח. אחר־כך יש לשלוח (post) למודול הזה עם linkcontinue ועם הגדרות של השדות הרלוונטיים ולחזור על צעד 4.
- אם קיבלת REDIRECT, יש להפנות את המשתמש ל־redirecttarget ולחכות לחזרה אל linkreturnurl. אחר־כך לשלוח (post) למודול הזה עם linkcontinue ועם כל השדות שהועברו ל־URL שחוזרים אליו ולחזור על צעד 4.
- אם קיבלת RESTART, זה אומר שהאימות עבד אבל אין חשבון משתמש מקושר. באפשרותך לטפל בזה כמו ב־UI או ב־FAIL.
- linkrequests
להשתמש רק בבקשות האימות האלו, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=link או מתשובה קודמת למודול הזה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- linkmessageformat
תסדיר לשימוש בהחזרת הודעות.
- אחד מהערכים הבאים: html, wikitext, raw, none
- ברירת מחדל: wikitext
- linkmergerequestfields
מיזוג מידע של שדות עבור כל בקשות האימות למערך אחד.
- סוג: בוליאני (פרטים)
- linkreturnurl
כתובת URL לחזרה עם זרימות אימות צד־שלישי, חייב להיות מוחלט. נדרש או זה או linkcontinue.
עם קבלת תשובת REDIRECT, בדרך־כלל תפתח דפדפן או תצוגת וב בכתובת ה־redirecttarget שצוינה בשביל זרימת אימות צד־שלישי. כשזה יושלם, הצד השלישי ישלח את הדפדפן או את תצוגת הווב לכתובת הזאת. יש לחלץ את כל הפרמטרים של שאילתה או בקשת POST מה־URL ולהעביר אותם בתור בקשת linkcontinue למודול ה־API הזה.
- linkcontinue
הבקשה הזאת היא המשך אחרי תשובת UI או REDIRECT קודמת. נדרש זה או linkreturnurl.
- סוג: בוליאני (פרטים)
- linktoken
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- *
- המודול הזה מקבל פרמטרים נוספים בהתאם לבקשות אימות זמינות. יש להשתמש ב־action=query&meta=authmanagerinfo עם amirequestsfor=link (או תגובה קודמת מהמודול הזה, אם זה זמין) כדי להבין מה הבקשות הזמינות ובאילו שדות הן משתמשות.
- תחילת תהליך הקישור לחשבון מ־Example.
- api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [פתיחה בארגז חול]
action=login (lg)
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
להיכנס ולקבל עוגיות אימות.
הפעולה הזאת צריכה לשמש רק בשילוב Special:BotPasswords; שימוש לכניסה לחשבון ראשי מיושן ועשוי להיכשל ללא אזהרה. כדי להיכנס בבטחה לחשבון הראשי, יש להשתמש ב־action=clientlogin.
- lgname
שם משתמש.
- lgpassword
ססמה.
- lgdomain
שם מתחם (רשות).
- lgtoken
אסימון "login" שאוחזר מ־action=query&meta=tokens
action=logout
- מקור: MediaWiki
- רישיון: GPL-2.0+
יציאה וניקוי של נתוני הפעילות.
- הוצאת המשתמש הנוכחי.
- api.php?action=logout [פתיחה בארגז חול]
action=managetags
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
ביצוע פעולות ניהוליות הקשורות בשינוי תגיות.
- operation
איזו פעולה לבצע:
- create
- יצירת תג שינוי חדש לשימוש ידני.
- delete
- הסרת תג שינוי ממסד הנתונים, כולל הסרת התג מכל הגרסאות, עיולי שינויים אחרונים ועיולי יומן שהוא משמש בהן.
- activate
- הפעלת תג שינוי, ואפשור למשתמש להחיל אותו ידנית.
- deactivate
- כיבוי תג שינוי, ומניעה ממשתמשים להחיל אותו ידנית.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: create, delete, activate, deactivate
- tag
תג ליצירה, מחיקה, הפעלה או כיבוי. ליצירת תג, התג לא צריך להיות קיים. למחיקת תג, התג צריך להיות קיים. להפעלת תג, התג צריך להתקיים ולא להיות בשימוש של הרחבה. לכיבוי תג, התג צריך להיות קיים ומוגדר ידנית.
- פרמטר זה נדרש.
- reason
סיבה אופציונלית ליצירה, מחיקה, הפעלה או כיבוי של תג.
- ignorewarnings
האם להתעלם מכל האזהרות שמופיעות תוך כדי הפעולה.
- סוג: בוליאני (פרטים)
- tags
תגי השינוי שיחולו על העיול ביומן ניהול התגים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- יצירת תג בשם spam עם הסיבה For use in edit patrolling
- api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [פתיחה בארגז חול]
- מחיקת התג vandlaism עם הסיבה Misspelt
- api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC [פתיחה בארגז חול]
- הפעלת התג spam עם הסיבה For use in edit patrolling
- api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [פתיחה בארגז חול]
- כיבוי התג spam עם הסיבה No longer required
- api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC [פתיחה בארגז חול]
action=mergehistory
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מיזוג גרסאות של דפים.
- from
כותרת הדף שההיסטוריה שלו תמוזג. לא ניתן להשתמש בזה יחד עם fromid.
- fromid
מזהה הדף שממנו תמוזג ההיסטוריה. לא ניתן להשתמש בזה יחד עם from.
- סוג: מספר שלם
- to
כותרת הדף שההיסטוריה תמוזג אליו. לא ניתן להשתמש בזה יחד עם toid.
- toid
מזהה הדף שההיסטוריה תמוזג אליו. לא ניתן להשתמש בזה יחד עם to.
- סוג: מספר שלם
- timestamp
חותם־הזמן שהגרסאות עד אליו יועברו מההיסטוריה של דף המקור על ההיסטוריה של דף היעד. אם מושמט, כל ההיסטוריה של דף המקור תמוזג עם דף היעד.
- סוג: חותם־זמן (תסדירים מורשים)
- reason
סיבה למיזוג ההיסטוריה.
- ברירת מחדל: (ריק)
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- מיזוג כל ההיסטוריה של Oldpage אל Newpage.
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason [פתיחה בארגז חול]
- מיזוג גרסאות הדפים של Oldpage עד 2015-12-31T04:37:41Z אל Newpage.
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason×tamp=2015-12-31T04%3A37%3A41Z [פתיחה בארגז חול]
action=move
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
העברת עמוד.
- from
שם הדף ששמו ישונה. לא יכול לשמש יחד עם fromid.
- fromid
מזהה הדף של הדף שצריך לשנות את שמו. לא יכול לשמש עם from.
- סוג: מספר שלם
- to
לאיזו כותרת לשנות את שם הדף.
- פרמטר זה נדרש.
- reason
הסיבה לשינוי השם.
- ברירת מחדל: (ריק)
- movetalk
שינוי שם דף השיחה, אם הוא קיים.
- סוג: בוליאני (פרטים)
- movesubpages
שינוי השמות של דפי־המשנה, אם זה שייך.
- סוג: בוליאני (פרטים)
- noredirect
לא ליצור הפניה.
- סוג: בוליאני (פרטים)
- watch
- מיושן.
הוספת הדף וההפניה לרשימת המעקב של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- unwatch
- מיושן.
הסרת הדף וההפניה מרשימת המעקב של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- watchlist
הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.
- אחד מהערכים הבאים: watch, unwatch, preferences, nochange
- ברירת מחדל: preferences
- ignorewarnings
להתעלם מכל האזהרות.
- סוג: בוליאני (פרטים)
- tags
תגי שינוי שיחולו על העיול ביומן ההעברות ולגרסה הריקה בדף היעד.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- העברת Badtitle ל־Goodtitle בלי להשאיר הפניה.
- api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect= [פתיחה בארגז חול]
action=opensearch
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
חיפוש בוויקי בפרוטוקול OpenSearch.
- search
מחרוזת לחיפוש.
- פרמטר זה נדרש.
- namespace
שמות מתחם לחיפוש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ברירת מחדל: 0
- limit
המספר המרבי של התוצאות שתוחזרנה.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- suggest
לא לעשות דבר אם $wgEnableOpenSearchSuggest הוא false.
- סוג: בוליאני (פרטים)
- redirects
איך לטפל בהפניות:
- return
- להחזיר את ההפניה עצמה.
- resolve
- להחזיר את דף היעד. יכול להחזיר פחות מ־limit תוצאות.
מסיבות היסטוריות, בררת המחדל היא "return" עבור format=json ו־"resolve" עבור תסדירים אחרים.
- אחד מהערכים הבאים: return, resolve
- format
תסדיר הפלט.
- אחד מהערכים הבאים: json, jsonfm, xml, xmlfm
- ברירת מחדל: json
- warningsaserror
אם אזהרות מוּעלות עם format=json, להחזיר שגיאת API במקום להתעלם מהן.
- סוג: בוליאני (פרטים)
- חיפוש דפים שמתחילים ב־Te.
- api.php?action=opensearch&search=Te [פתיחה בארגז חול]
action=options
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שינוי העדפות של המשתמש הנוכחי.
רק אפשרויות שמוגדרות בליבה או באחת מההרחבות המותקנות, או אפשרויות עם מפתחות עם התחילית "userjs-" (שמיועדות לשימוש תסריטי משתמשים) יכולות להיות מוגדרות.
- reset
אתחול ההעדפות לבררות המחדל של האתר.
- סוג: בוליאני (פרטים)
- resetkinds
רשימת סוגי אפשרויות לאתחל כאשר מוגדרת האפשרות reset.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all
- ברירת מחדל: all
- change
רשימת שינויים, בתסדיר name=value (למשל skin=vector). אם לא ניתן ערך, אפילו לא סימן שווה, למשל optionname|otheroption|..., האפשרות תאופס לערך בררת המחדל שלה. אם ערך מועבר כלשהו מכיל את תו המקל (|), יש להשתמש במפריד ערכים מרובים חלופי בשביל פעולה נכונה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- optionname
שם האפשרות שצריך להגדיר לערך שניתן ב־optionvalue.
- optionvalue
ערך האפשרות שצוין ב־optionname.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- אתחול כל ההעדפות.
- api.php?action=options&reset=&token=123ABC [פתיחה בארגז חול]
- לשנות את ההעדפות skin ו־hideminor.
- api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [פתיחה בארגז חול]
- לאתחל את כל ההעדפות ואז להגדיר את skin ואת nickname.
- api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [פתיחה בארגז חול]
action=paraminfo
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע על יחידות של API.
- modules
רשימה של שמות יחידות (ערכים של הפרמטרים action ו־format, או main). אפשר להגדיר תת־יחידות עם +, או כל התת־מודולים עם +*, או כל התת־מודולים באופן רקורסיבי עם +**.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- helpformat
תסדיר מחרוזות העזרה.
- אחד מהערכים הבאים: html, wikitext, raw, none
- ברירת מחדל: none
- querymodules
- מיושן.
רשימת שמות יחידות query (ערך של הפרמטר prop, meta או list). יש להשתמש ב־modules=query+foo במקום querymodules=foo.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, backlinks, blocks, categories, categoryinfo, categorymembers, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, exturlusage, filearchive, filerepoinfo, fileusage, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, links, linkshere, logevents, mystashedfiles, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, usercontribs, userinfo, users, watchlist, watchlistraw
- מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- mainmodule
- מיושן.
קבלת מידע עם היחידה הראשית (העליונה). יש להשתמש ב־modules=main במקום זה.
- pagesetmodule
- מיושן.
קבלת מידע גם על יחידת pageset (שמספק את titles= וידידיו).
- formatmodules
- מיושן.
רשימת שמות תסדירים (ערכים של הפרמטר format). יש להשתמש ב־modules במקום זה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- הצגת מידע עבור action=parse, format=jsonfm, action=query&list=allpages, ו־action=query&meta=siteinfo.
- api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo [פתיחה בארגז חול]
- הצגת מידע עבור כל התת־מודולים של action=query.
- api.php?action=paraminfo&modules=query%2B* [פתיחה בארגז חול]
action=parse
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מפענח את התוכן ומחזיר פלט מפענח.
ר' את יחידת ה־prop השיונות של action=query כדי לקבל מידע על הגרסה הנוכחית של הדף.
יש מספר דרכים לציין טקסט לפענוח:
- ציון דף או גרסה באמצעות page, pageid, או oldid.
- ציון התוכן במפורש, באמצעות text, title, ו־contentmodel.
- ציון רק של התקציר לפענוח. ל־prop צריך לתת ערך ריק.
- title
שם הדף שהטקסט שייך אליו. אם זה מושמט, יש לציין את contentmodel, ו־API ישמש ככותרת.
- text
הטקסט לפענוח. יש להשתמש ב־title או ב־contentmodel.
- summary
התקציר שצריך לפענח.
- page
פענוח תוכן הדף הזה. לא יכול לשמש יחד עם text ו־title.
- pageid
לפענח את התוכן של הדף הזה. דורס את page.
- סוג: מספר שלם
- redirects
אם page או pageid מוגדרים להפניה, לפתור אותה.
- סוג: בוליאני (פרטים)
- oldid
לפענח את התוכן של הגרסה הזאת. דורס את page ואת pageid.
- סוג: מספר שלם
- prop
אילו פריטי מידע לקבל:
- text
- נותן טקסט מפוענח של קוד הוויקי.
- langlinks
- נותן קישורי שפה בקוד הוויקי המפוענח.
- categories
- נותן קטגוריות בקוד ויקי מפוענח.
- categorieshtml
- נותן את גרסת ה־HTML של הקטגוריות.
- links
- נותן קישורים פנימיים בקוד הוויקי המפוענח.
- templates
- נותן תבניות בקוד הוויקי המפוענח.
- images
- נותן תמונות בקוד הוויקי המפוענח.
- externallinks
- מתן קישורים חיצוניים בקוד הוויקי המפוענח.
- sections
- מתן הפסקאות בקוד הוויקי המפוענח.
- revid
- הוספת מזהה הגרסה של הדף המפוענח.
- displaytitle
- הוספת הכותרת של קוד הוויקי המפוענח.
- headitems
- לא בשימוש. נותן פריטים לשים ב־
<head>של הדף. - headhtml
- נותן את ה־
<head>המפוענח של הדף. - modules
- מתן יחידות ResourceLoader שמשמשות בדף. כדי לטעון, יש להשתמש ב
mw.loader.using(). יש לבקש את jsconfigvars או את encodedjsconfigvars יחד עם modules. - jsconfigvars
- נותן משתני הגדרות של JavaScript שייחודיים לדף הזה. כדי להחיל, יש להשתמש ב
mw.config.set(). - encodedjsconfigvars
- נותן משתני הגדרות של JavaScript שייחודיים לדף הזה בתור מחרוזת JSON.
- indicators
- נותן את ה־HTML של מחווני מצב דף שמשמשים בדף.
- iwlinks
- מתן קישורי בינוויקי בקוד הוויקי המפוענח.
- wikitext
- מתן קוד הוויקי המקורי שפוענח.
- properties
- נותן מאפיינים שונים שמוגדרים בקוד הוויקי המפוענח.
- limitreportdata
- נותן דו"ח הגבלות בדרך מובנית. לא נותן שום נתונים כאשר מוגדר disablelimitreport.
- limitreporthtml
- נותן את גרסת ה־HTML של דו"ח ההגבלות. לא נותן שום נתונים כאשר מוגדר disablelimitreport.
- parsetree
- עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן
wikitext) - parsewarnings
- נותן אזהרות שאירעו בזמן פענוח התוכן.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headitems, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree, parsewarnings
- ברירת מחדל: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- pst
לעשות התמרה לפני שמירה על הקלט לפני פענוחו. תקין רק בשימוש עם טקסט.
- סוג: בוליאני (פרטים)
- onlypst
לעשות התמרה לפני שמירה (pre-save transform, PST) על הקלט, אבל לא לפענח אותו. מחזיר את אותו קוד הוויקי אחרי החלת PST. תקף רק בשימוש עם text.
- סוג: בוליאני (פרטים)
- effectivelanglinks
כולל קישור שפה שמספקות הרחבות (לשימוש עם prop=langlinks).
- סוג: בוליאני (פרטים)
- section
לפענח רק את התוכן של הפסקה שזה מספרה.
כשצוין new, לפענח את text ואת sectiontitle כאילו נוספת פסקה חדשה לדף.
מותר להשתמש ב־new רק בעת שימוש ב־text.
- sectiontitle
כותרת פסקה חדשה כאשר section הוא new.
בניגוד לעריכת דף, זה לא מתגבה ל־summary כשזה מושמט אם ריק.
- disablepp
- מיושן.
יש להשתמש ב־disablelimitreport במקום.
- סוג: בוליאני (פרטים)
- disablelimitreport
להשמיט את דו"ח הקדם־מעבד ("NewPP limit report") מפלט המפענח.
- סוג: בוליאני (פרטים)
- disableeditsection
להשמיט את קישורי עריכת הפסקאות מפלט המפענח.
- סוג: בוליאני (פרטים)
- disabletidy
לא להריץ ניקוי HTML (למשל tidy) על פלט המפענח.
- סוג: בוליאני (פרטים)
- generatexml
- מיושן.
יצירת עץ פענוח של XML (נדרש מודל תוכן
wikitext; מוחלף ב־prop=parsetree).- סוג: בוליאני (פרטים)
- preview
לפענח במצב תצוגה מקדימה.
- סוג: בוליאני (פרטים)
- sectionpreview
לפענח במצב תצוגה מקדימה של פסקה (מדליק גם את מצב תצוגה מקדימה).
- סוג: בוליאני (פרטים)
- disabletoc
להשמיט את תוכן העניינים בפלט.
- סוג: בוליאני (פרטים)
- contentformat
תסדיר הסדרת תוכן שישמש לטקסט הקלט. תקף רק עם text.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- contentmodel
מודל התוכן של טקסט הקלט. אם זה מושמט, יש לציין את title והערך ההתחלתי יהיה המודל של הכותרת שצוינה. תקין רק כאשר משמש עם text.
- אחד מהערכים הבאים: wikitext, javascript, json, css, text
- לפענח דף.
- api.php?action=parse&page=Project:Sandbox [פתיחה בארגז חול]
- לפענח קוד ויקי.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [פתיחה בארגז חול]
- לפענח קוד, עם ציון כותרת דף.
- api.php?action=parse&text={{PAGENAME}}&title=Test [פתיחה בארגז חול]
- לפענח תקציר.
- api.php?action=parse&summary=Some+[[link]]&prop= [פתיחה בארגז חול]
action=patrol
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לנטר דף או גרסה.
- rcid
מזהה שינויים אחרונים לניטור.
- סוג: מספר שלם
- revid
מזהה גרסה לניטור.
- סוג: מספר שלם
- tags
תגי שינוי שיחולו על העיול ביומן הניטור.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "patrol" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לנטר רשומה משינויים אחרונים.
- api.php?action=patrol&token=123ABC&rcid=230672766 [פתיחה בארגז חול]
- לנטר גרסה.
- api.php?action=patrol&token=123ABC&revid=230672766 [פתיחה בארגז חול]
action=protect
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לשנות את רמת ההגנה של דף.
- title
כותרת הדף להגנה או הסרת הגנה. לא ניתן להשתמש בזה יחד עם pageid.
- pageid
מזהה הדף להגנה או הסרת הגנה. לא ניתן להשתמש בזה יחד עם title.
- סוג: מספר שלם
- protections
רשימת רמות הגנה, בתסדיר action=level (למשל edit=sysop). רמת all פירושה שכולם מורשים לבצע את הפעולה, כלומר אין הגנה.
הערה: ההגבלות יוסרו מכל הפעולות שלא כתובות ברשימה.
- פרמטר זה נדרש.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- expiry
חותמי־זמן של תפוגה. אם הוגדר רק חותם־זמן אחד, הוא ישמש לכל ההגנות. יש להשתמש ב־infinite, indefinite, infinity, או never להגנה שלא פגה לעולם.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ברירת מחדל: infinite
- reason
סיבה להגנה או הסרת הגנה.
- ברירת מחדל: (ריק)
- tags
תגי שינוי שיחולו על העיול ביומן ההגנה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- cascade
הפעלת הגנה מדורגת (כלומר, להגן על דפים שמוכללים בדף הזה ועל תמונות שמשמות בו). אין לזה השפעה אם אף אחת מרמות ההגנה שניתנו אינה תומכת בדירוג.
- סוג: בוליאני (פרטים)
- watch
- מיושן.
אם זה מוגדר, הוספת הדף שהגנה נוספת אליו או מוסרת ממנו לרשימת המעקב של המשתמש הנוכחי.
- סוג: בוליאני (פרטים)
- watchlist
הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.
- אחד מהערכים הבאים: watch, unwatch, preferences, nochange
- ברירת מחדל: preferences
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- הגנה על דף.
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never [פתיחה בארגז חול]
- להסיר את ההגנה מהדף על־ידי הגדרת מגבלות על all (למשל: כולם מורשים לבצע את הפעולה).
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions [פתיחה בארגז חול]
- הסרת הגנה מדף על־ידי הגדרה של אפס הגבלות.
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions [פתיחה בארגז חול]
action=purge
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
ניקוי המטמון לכותרות שניתנו.
- forcelinkupdate
עדכון טבלאות הקישורים.
- סוג: בוליאני (פרטים)
- forcerecursivelinkupdate
עדכון טבלת הקישורים ועדכון טבלאות הקישורים עבור כל דף שמשתמש בדף הזה בתור תבנית.
- סוג: בוליאני (פרטים)
- continue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- titles
רשימת כותרות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pageids
רשימת מזהי דף לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- revids
רשימת מזהי גרסה לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- generator
קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.
לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz וגם zh.
- סוג: בוליאני (פרטים)
- ניקוי המטמון של הדפים Main Page ו־API.
- api.php?action=purge&titles=Main_Page|API [פתיחה בארגז חול]
- ניקוי 10 הדפים הראשונים במרחב הראשי.
- api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [פתיחה בארגז חול]
action=query
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
אחזור נתונים ממדיה־ויקי ועליה.
כל שינויי הנתונים יצטרכו תחילה להשתמש ב־query כדי לקבל אסימון למניעת שימוש לרעה מאתרים זדוניים.
- prop
אילו מאפיינים לקבל על הדפים בשאילתה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin
- list
אילו רשימות לקבל.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, categorymembers, deletedrevs, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks, logevents, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw
- meta
אילו מטא־נתונים לקבל.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allmessages, authmanagerinfo, filerepoinfo, siteinfo, tokens, userinfo
- indexpageids
לכלול פסקת pageids נוספת עם רשימת כל מזהי הדף שהוחזרו.
- סוג: בוליאני (פרטים)
- export
יצוא הגרסאות הנוכחיות של כל הדפים הנתונים המחוללים.
- סוג: בוליאני (פרטים)
- exportnowrap
להחזיר את ה־XML של היצוא בלי לעטוף אותו בתוצאת XML (אותו תסדיר כמו Special:Export). אפשר להשתמש בזה רק עם export.
- סוג: בוליאני (פרטים)
- iwurl
האם לקבל את ה־URL המלא אם הכותרת היא קישור בינוויקי.
- סוג: בוליאני (פרטים)
- continue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- rawcontinue
להחזיר נתוני query-continue גולמיים להמשך.
- סוג: בוליאני (פרטים)
- titles
רשימת כותרות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pageids
רשימת מזהי דף לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- revids
רשימת מזהי גרסה לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- generator
קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.
לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz וגם zh.
- סוג: בוליאני (פרטים)
- אחזור site info ו־revisions של Main Page.
- api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue= [פתיחה בארגז חול]
- אחזור גרסאת של דפים שמתחילים ב־API/.
- api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [פתיחה בארגז חול]
prop=categories (cl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לרשום את כל הקטגוריות שהדף שייך אליהן.
- clprop
אילו מאפיינים נוספים לקבל עבור כל קטגוריה:
- sortkey
- הוספת מפתח מיון (מחרוזת הקסדצימלית) ותחילית מפתח מיון (החלק הקריא) עבור קטגוריה.
- timestamp
- הוספת חותם־הזמן של יצירת הקטגוריה.
- hidden
- תיוג קטגוריות שהוסתרו באמצעות
__HIDDENCAT__.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): sortkey, timestamp, hidden
- clshow
איזה סוג של קטגוריות להציג.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): hidden, !hidden
- cllimit
כמה קטגוריות להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- clcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- clcategories
לרשום רק את הקטגוריות האלו. שימושי לבדיקה עם דף מסוים נמצא בקטגוריה מסוימת.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- cldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- קבלת רשימת קטגוריות שהם Albert Einstein שייך אליהן.
- api.php?action=query&prop=categories&titles=Albert%20Einstein [פתיחה בארגז חול]
- קבלת מידע על כל הקטגוריות שמשמשות בדף Albert Einstein.
- api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [פתיחה בארגז חול]
prop=categoryinfo (ci)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת מידע על הקטגוריות הנתונות.
- cicontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבחצ מידע על Category:Foo ועל Category:Bar.
- api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [פתיחה בארגז חול]
prop=contributors (pc)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת רשימה של תורמים שנכנסו לחשבון ומניין של תורמים אלמוניים לדף.
- pcgroup
לכלול רק משתמשים בקבוצות הנתונות. לא כולל קבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): bot, sysop, bureaucrat
- pcexcludegroup
לא לכלול משתמשים בקבוצות הנתונות. לא כולל קבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): bot, sysop, bureaucrat
- pcrights
לכלול רק משתמשים עם ההרשאות הנתונות. לא כולל הרשאות שניתנו בקבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 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, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, 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
- מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pcexcluderights
לא לכלול משתמשים עם ההרשאות הנתונות. לא כולל הרשאות שניתנו בקבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 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, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, 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
- מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pclimit
כמה תורמים להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- pccontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- הצגת תורמים לדף Main Page.
- api.php?action=query&prop=contributors&titles=Main_Page [פתיחה בארגז חול]
prop=deletedrevisions (drv)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע על גרסה מחוקה.
יכול לשמש במספר דרכים:
- קבלת גרסאות מחוקות עבור ערכת דפים, על־ידי הגדרת שמות או מזהי דף. ממוין לפי שם וחותם־זמן.
- קבלת מידע על ערכת גרסאות מחוקות באמצעות הגדרת המזהים שלהם עם revid־ים. ממוין לפי מזהה גרסה.
- drvprop
אילו מאפיינים לקבל עבור כל גרסה:
- ids
- מזהה הגרסה.
- flags
- דגלי גרסה (משני).
- timestamp
- חותם־הזמן של הגרסה.
- user
- המתמש שעשה את הגרסה
- userid
- מזהה המשתמש של יוצר הגרסה.
- size
- אורך (בבייטים) של הגרסה.
- sha1
- SHA-1 (בבסיס 16) של הגרסה.
- contentmodel
- מזהה מודל התוכן של הגרסה.
- comment
- הערה מאת המשתמש על הגרסה.
- parsedcomment
- הערה מפוענחת מאת המשתמש על הגרסה.
- content
- הטקסט של הגרסה.
- tags
- התגים עבור הגרסה.
- parsetree
- עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן
wikitext).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
- ברירת מחדל: ids|timestamp|flags|comment|user
- drvlimit
הגבלת מספר הגרסאות שיוחזרו.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- drvexpandtemplates
להרחיב תבניות בתוכן הגרסה (דורש drvprop=content).
- סוג: בוליאני (פרטים)
- drvgeneratexml
- מיושן.
יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את drvprop=content; מוחלף ב־drvprop=parsetree).
- סוג: בוליאני (פרטים)
- drvparse
פענוח תוכן הגרסה (דורש drvprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, drvlimit נכפה לערך 1.
- סוג: בוליאני (פרטים)
- drvsection
לאחזר רק את התוכן של הפִסקה עם המספר הזה.
- drvdiffto
מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.
- drvdifftotext
הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את drvdiffto. אם מוגדר drvsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.
- drvdifftotextpst
ביצוע התמרה לפני שמירה על הטקסט לפני הרצת השוואה. תקף רק כשמשמש עם drvdifftotext.
- סוג: בוליאני (פרטים)
- drvcontentformat
תסדיר ההסדרה שמשמש את drvdifftotext וצפוי לפלט של תוכן.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- drvstart
מאיזה חותם־זמן להתחיל למנות. לא תקף בעיבוד רשימת מזהי גרסה.
- סוג: חותם־זמן (תסדירים מורשים)
- drvend
באיזה חותם־זמן להפסיק למנות. לא תקף בעת עיבוד רשימת מזהי גרסה.
- סוג: חותם־זמן (תסדירים מורשים)
- drvdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: drvstart חייב להיות לפני drvend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: drvstart חייב להיות אחרי drvend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- drvtag
לרשום רק גרסאות עם התג הזה.
- drvuser
לרשום רק גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- drvexcludeuser
לא לרשום גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- drvcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- רשימת גרסאות מחוקות של הדפים Main Page ו־Talk:Main Page, עם תוכן.
- api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content [פתיחה בארגז חול]
- קבלת מידע לגרסה המחוקה 123456.
- api.php?action=query&prop=deletedrevisions&revids=123456 [פתיחה בארגז חול]
prop=duplicatefiles (df)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת כל הקבצים שהם כפולים של קבצים נתונים לפי ערכי הגיבוב.
- dflimit
כמה קבצים כפולים להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- dfcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- dfdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- dflocalonly
חיפוש אחר קבצים במאגר המקומי בלבד.
- סוג: בוליאני (פרטים)
- חיפוש אחר כפילויות של קובץ:Albert Einstein Head.jpg.
- api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles [פתיחה בארגז חול]
- חיפוש אחר כפילויות בין כל הקבצים.
- api.php?action=query&generator=allimages&prop=duplicatefiles [פתיחה בארגז חול]
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles){kind=link}
prop=extlinks (el)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת כל ה־URL־ים החיצוניים (לא בינוויקי) מהדפים הנתונים.
- ellimit
כמה קישורים להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- eloffset
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- סוג: מספר שלם
- elprotocol
הפרוטוקול של ה־URL. אם זה ריק, ו־elquery מוגדר, הפרוטוקול הוא http. יש להשאיר את זה ואת elquery ריק כדי לרשום את כל הקישורים החיצוניים.
- אחד מהערכים הבאים: יכול להיות ריק או 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
- ברירת מחדל: (ריק)
- elquery
מחרוזת חיפוש ללא פרוטוקול. שימושי לבדיקה האם דף מסוים מכיל url חיצוני מסוים.
- elexpandurl
הרחבת URL־ים בעלי פרוטוקול יחסי בפרוטוקול קנוני.
- סוג: בוליאני (פרטים)
- קבלת רשימת קישורים חיצוניים ב־Main Page.
- api.php?action=query&prop=extlinks&titles=Main%20Page [פתיחה בארגז חול]
prop=fileusage (fu)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאת כל הדפים שמשתמשים בקבצים הנתונים.
- fuprop
אילו מאפיינים לקבל:
- pageid
- מזהה הדף של כל דף.
- title
- השם של כל דף.
- redirect
- דגל אם הדף הוא הפניה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): pageid, title, redirect
- ברירת מחדל: pageid|title|redirect
- funamespace
לכלול רק דפים במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- fushow
לחפש רק פריטים שמתאימים לאמות המידה הבאות:
- redirect
- להציג רק הפניות.
- !redirect
- לא להציג הפניות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): redirect, !redirect
- fulimit
כמה להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- fucontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבלת רשימת דפים שמשתמשים ב־File:Example.jpg.
- api.php?action=query&prop=fileusage&titles=File%3AExample.jpg [פתיחה בארגז חול]
- קבלת מידע על דפים שמשתמשים ב־File:Example.jpg.
- api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info [פתיחה בארגז חול]
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&prop=fileusage&titles=File%3AExample.jpg){kind=link}
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info){kind=link}
prop=imageinfo (ii)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת מידע על קובץ והיסטורייה העלאה.
- iiprop
איזה מידע על הקובץ לקבל:
- timestamp
- הוספת חותם־זמן לגרסה שהועלתה.
- user
- הוספה המשתמש שהעלה כל גרסה של קובץ.
- userid
- הוספת מזהה המשתמש שהעלה כל גרסה של קובץ.
- comment
- תגובה על הגרסה.
- parsedcomment
- פענוח ההערה על גרסה.
- canonicaltitle
- הוספת הכותרת הקנונית של הקובץ.
- url
- מתן URL לקובץ ולדף התיאור.
- size
- הוספת הגודל של הקובץ בבייטים והגובה, הרוחב ומניין הדפים (אם זה מתאים).
- dimensions
- כינוי ל־size.
- sha1
- הוספת גיבוב SHA-1 עבור הקובץ.
- mime
- הוספת סוג ה־MIME של הקובץ.
- thumbmime
- הוספת סוג ה־MIME של התמונה הממוזערת (נדרש url והפרמטר iiurlwidth).
- mediatype
- הוספת סוג המדיה של הקובץ.
- metadata
- טעינת מטא־נתונים של Exif עבור גרסת הקובץ.
- commonmetadata
- רשימת מטא־נתונים כלליים על תסדיר הקובץ עבור גרסת הקובץ.
- extmetadata
- רשימת מטא־נתונים מעוצבים משולבים ממספר מקורות. התוצאה מעוצבת ב־HTML.
- archivename
- הוספת שם הקובץ של גרסת הארכיון עבור הגרסאות שאינן האחרונה.
- bitdepth
- הוספת עומק הביטים של הגרסה.
- uploadwarning
- משמש את Special:Upload כדי לקבל מידע על קובץ קיים. לא נועד לשימוש מחוץ לליבת MediaWiki.
- badfile
- מוסיף האם הקובץ נמצא ב־MediaWiki:Bad image list
- ערכים (מופרדים באמצעות "|" או or תו חלופי): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning, badfile
- ברירת מחדל: timestamp|user
- iilimit
כמה גרסאות של קובץ לכל קובץ.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 1
- iistart
מאיז חותם־זמן להתחיל רשימה.
- סוג: חותם־זמן (תסדירים מורשים)
- iiend
באיזה חותם־זמן לסיים את הרשימה.
- סוג: חותם־זמן (תסדירים מורשים)
- iiurlwidth
אם מוגדר iiprop=url, יוחזר URL לתמונה שגודלה הותאם לרוחב הזה. מסיבות של ביצועים, אם האפשרות הזאת משמשת, לא יוחזרו יותר מ־50 תמונות.
- סוג: מספר שלם
- ברירת מחדל: -1
- iiurlheight
דומה ל־iiurlwidth.
- סוג: מספר שלם
- ברירת מחדל: -1
- iimetadataversion
גרסת המטא־נתונים לשימוש. אם מוגדר latest, להשתמש בגרסה החדשה ביותר. בררת המחדל היא 1 לצורך תאימות אחורה.
- ברירת מחדל: 1
- iiextmetadatalanguage
באיזו שפה לאחזר את המטא־נתונים. זה משפיע על אילו תרגומים לאחזר, האם יש כמה, וגם איך דברים כמו מספרים וערכים שונים מעוצבים.
- ברירת מחדל: he
- iiextmetadatamultilang
אם תרגומים של המאפיין extmetadata זמינים, לאחזר את כולם.
- סוג: בוליאני (פרטים)
- iiextmetadatafilter
אם זה מוגדר ולא ריק, רק המפתחות האלה יוחזרו עבור iiprop=extmetadata.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- iiurlparam
מחרוזת פרמטר ייחודית למטפל. למשל, PDF־ים יכולים להשתמש ב־page15-100px. iiurlwidth צריך לשמש ולהיות עקבי עם iiurlparam.
- ברירת מחדל: (ריק)
- iibadfilecontexttitle
אם badfilecontexttitleprop=badfile מוגדר, זאת כותרת הדף שתשמש בזמן שערוך ה־MediaWiki:Bad image list
- iicontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- iilocalonly
חיפוש אחר קבצים במאגר המקומי בלבד.
- סוג: בוליאני (פרטים)
- קבלת מידע על הגרסה הנוכחית של File:Albert Einstein Head.jpg.
- api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo [פתיחה בארגז חול]
- אחזור מידע על גרסאות של File:Test.jpg מ־2008 ואחרי־כן.
- api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url [פתיחה בארגז חול]
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo){kind=link}
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url){kind=link}
prop=images (im)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
להחזיר את כל הקבצים שמכילים הדפים הנתונים.
- imlimit
כמה קבצים להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- imcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- imimages
לרשום רק את הקבצים האלה. שימוש לבדיקת האם לדף מסוים יש קובץ מסוים.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- imdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- קבלת רשימת קבצים שמשמשים ב־Main Page.
- api.php?action=query&prop=images&titles=Main%20Page [פתיחה בארגז חול]
- קבלת מידע על כל הקבצים שמשמשים ב־Main Page.
- api.php?action=query&generator=images&titles=Main%20Page&prop=info [פתיחה בארגז חול]
prop=info (in)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע בסיסי על הדף.
- inprop
אילו מאפיינים נוספים לקבל:
- protection
- לרשום את רמת ההגנה של כל דף.
- talkid
- מזהה הדף של דף השיחה עבור כל דף שאינו דף שיחה.
- watched
- לרשום את מצב המעקב של כל דף.
- watchers
- מספר העוקבים, אם קיבלת הרשאה.
- visitingwatchers
- מספר העוקבים אחרי כל דף שביקרו עריכות אחרונות לאותו הדף, אם זה מותר.
- notificationtimestamp
- חותם־זמן של הודעת רשימת מעקב של כל דף.
- subjectid
- מזהה הדף של הדף העיקרי של כל דף שיחה.
- url
- נותן URL מלא, URL לעריכה ו־URL קנוני לכל דף.
- readable
- האם המשתמש יכול להציג דף זה.
- preload
- נותן את הטקסט שמוחזר על־ידי EditFormPreloadText.
- displaytitle
- נותן את האופן שבה שם הדף באמת מוצג.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): protection, talkid, watched, watchers, visitingwatchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle
- intestactions
בדיקה האם המשתמש הנוכחי יכול לבצע פעולות מסוימות על הדף.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- intoken
- מיושן.
להשתמש ב־action=query&meta=tokens במקום.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): edit, delete, protect, move, block, unblock, email, import, watch
- incontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבלת מידע על הדף Main Page
- api.php?action=query&prop=info&titles=Main%20Page [פתיחה בארגז חול]
- קבלת מידע כללי ומידע על הגנה של הדף Main Page.
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [פתיחה בארגז חול]
prop=iwlinks (iw)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת כל קישורי הבינוויקי מהדפים הנתונים.
- iwprop
אילו מאפיינים נוספים לקבל עבור כל קישור בין־לשוני:
- url
- הוספת ה־URL המלא.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): url
- iwprefix
להחזיר רק קישורי בינוויקי עם התחילית הזאת.
- iwtitle
איזה קישור בינוויקי לחפש. צריך להשתמש בזה יחד עם iwprefix.
- iwdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- iwlimit
כמה קישורי בינוויקי להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- iwcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- iwurl
- מיושן.
האם לקבל את ה־URL המלא (לא יכול לשמש עם iwprop).
- סוג: בוליאני (פרטים)
- קבלת קישורי בינוויקי מהדף Main Page.
- api.php?action=query&prop=iwlinks&titles=Main%20Page [פתיחה בארגז חול]
prop=langlinks (ll)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת כל הקישורים הבין־לשוניים מהדפים הנתונים.
- llprop
אילו מאפיינים נוספים לקבל עבור כל קישור בין־לשוני:
- url
- הוספת ה־URL המלא.
- langname
- הוספת שם השפה המתורגם (עם המאמץ הטוב ביותר). יש להשתמש ב־llinlanguagecode כדי לשלוט בשפה.
- autonym
- הוספת השם הילידי של השפה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): url, langname, autonym
- lllang
להחזיר רק קישורי שפה עם קוד השפה הזה.
- lltitle
קישור לחיפוש. חובה להשתמש עם lllang.
- lldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- llinlanguagecode
קוד שפה ששמות שפות מתורגמות.
- ברירת מחדל: he
- lllimit
כמה קישורי שפה להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- llcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- llurl
- מיושן.
האם לקבל את ה־URL המלא (לא יכול לשמש עם llprop).
- סוג: בוליאני (פרטים)
- קבלת קישורים בין־לשוניים מהדף Main Page.
- api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [פתיחה בארגז חול]
prop=links (pl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת כל הקישורים מהדפים שצוינו.
- plnamespace
להציג קישורים רק במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- pllimit
כמה קישורים להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- plcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- pltitles
לרשום רק קישורים לכותרות האלו. שימושי לבדיקה האם דף מסוים מקשר לכותרת מסוימת.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- קבלת קישורים מהדף Main Page
- api.php?action=query&prop=links&titles=Main%20Page [פתיחה בארגז חול]
- קבלת מידע על דפי הקישור בדף Main Page.
- api.php?action=query&generator=links&titles=Main%20Page&prop=info [פתיחה בארגז חול]
- קבלת קישורים מהדף Main Page במרחבי השם משתמש ו־תבנית.
- api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [פתיחה בארגז חול]
prop=linkshere (lh)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאת כל הדפים שמקשרים לדפים הנתונים.
- lhprop
אילו מאפיינים לקבל:
- pageid
- מזהה הדף של כל דף.
- title
- השם של כל דף.
- redirect
- דגל אם הדף הוא הפניה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): pageid, title, redirect
- ברירת מחדל: pageid|title|redirect
- lhnamespace
לכלול רק דפים במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- lhshow
הצגת פריטים שתואמים את הדרישות הללו בלבד:
- redirect
- הצגת הפניות בלבד.
- !redirect
- הצגת קישורים שאינם הפניות בלבד.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): redirect, !redirect
- lhlimit
כמה להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- lhcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבלת רשימת דפים שמקשרים ל־Main Page.
- api.php?action=query&prop=linkshere&titles=Main%20Page [פתיחה בארגז חול]
- קבל מידע על דפים שמקשרים ל־Main Page.
- api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info [פתיחה בארגז חול]
prop=pageprops (pp)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מאפייני דף שונים שמוגדרים בתוכן הדף.
- ppcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- ppprop
לרשום רק את המאפיינים האלה (שימוש ב־action=query&list=pagepropnames מחזיר רשימת שמות מאפייני דף בשימוש). זה שימושי לבדיקה האם דפים משתמשים במאפיין דף מסוים.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- קבלת מאפיינים עבור הדפים Main Page ו־MediaWiki.
- api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [פתיחה בארגז חול]
prop=redirects (rd)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מחזיר את כל ההפניות לדפים הנתונים.
- rdprop
אילו מאפיינים לקבל:
- pageid
- מזהה הדף של כל הפניה.
- title
- השם של כל הפניה.
- fragment
- מובאה מכל הפניה, אם יש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): pageid, title, fragment
- ברירת מחדל: pageid|title
- rdnamespace
לכלול רק דפים במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- rdshow
לחפש רק פריטים שמתאימים לאמות המידה הבאות:
- fragment
- להציג רק הפניות עם מקטע.
- !fragment
- להציג רק הפניות ללא מקטע.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): fragment, !fragment
- rdlimit
כמה הפניות להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- rdcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבלת רשימת הפניות ל־Main Page
- api.php?action=query&prop=redirects&titles=Main%20Page [פתיחה בארגז חול]
- קבלת מידע על כל ההפניות ל־Main Page.
- api.php?action=query&generator=redirects&titles=Main%20Page&prop=info [פתיחה בארגז חול]
prop=revisions (rv)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע על גרסה.
יכול לשמש במספר דרכים:
- קבלת נתונים על ערכת דפים (גרסה אחרונה), באמצעות כותרות או מזהי דף.
- קבלת גרסאות עבור דף נתון אחד, באמצעות שימוש בכותרות או במזהי דף עם start, end או limit.
- קבלת נתונים על ערכת גרסאות באמצעות הגדרת המזהים שלהם עם revid־ים.
- rvprop
אילו מאפיינים לקבל עבור כל גרסה:
- ids
- מזהה הגרסה.
- flags
- דגלי גרסה (משני).
- timestamp
- חותם־הזמן של הגרסה.
- user
- המתמש שעשה את הגרסה
- userid
- מזהה המשתמש של יוצר הגרסה.
- size
- אורך (בבייטים) של הגרסה.
- sha1
- SHA-1 (בבסיס 16) של הגרסה.
- contentmodel
- מזהה מודל התוכן של הגרסה.
- comment
- הערה מאת המשתמש על הגרסה.
- parsedcomment
- הערה מפוענחת מאת המשתמש על הגרסה.
- content
- הטקסט של הגרסה.
- tags
- התגים עבור הגרסה.
- parsetree
- עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן
wikitext).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
- ברירת מחדל: ids|timestamp|flags|comment|user
- rvlimit
הגבלת מספר הגרסאות שיוחזרו.
- יכול לשמש רק עם דף בודד (mode #2).
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- rvexpandtemplates
להרחיב תבניות בתוכן הגרסה (דורש rvprop=content).
- סוג: בוליאני (פרטים)
- rvgeneratexml
- מיושן.
יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את rvprop=content; מוחלף ב־rvprop=parsetree).
- סוג: בוליאני (פרטים)
- rvparse
פענוח תוכן הגרסה (דורש rvprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, rvlimit נכפה לערך 1.
- סוג: בוליאני (פרטים)
- rvsection
לאחזר רק את התוכן של הפִסקה עם המספר הזה.
- rvdiffto
מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.
- rvdifftotext
הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את rvdiffto. אם מוגדר rvsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.
- rvdifftotextpst
ביצוע התמרה לפני שמירה על הטקסט לפני הרצת השוואה. תקף רק כשמשמש עם rvdifftotext.
- סוג: בוליאני (פרטים)
- rvcontentformat
תסדיר ההסדרה שמשמש את rvdifftotext וצפוי לפלט של תוכן.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- rvstartid
מאיזה מזהה גרסה להתחיל למנות.
- יכול לשמש רק עם דף בודד (mode #2).
- סוג: מספר שלם
- rvendid
באיזה מזהה גרסה להפסיק את מניית הגרסאות.
- יכול לשמש רק עם דף בודד (mode #2).
- סוג: מספר שלם
- rvstart
מאיזה חותם־זמן של גרסה להתחיל למנות.
- יכול לשמש רק עם דף בודד (mode #2).
- סוג: חותם־זמן (תסדירים מורשים)
- rvend
למנות עד חותם־הזמן הזה.
- יכול לשמש רק עם דף בודד (mode #2).
- סוג: חותם־זמן (תסדירים מורשים)
- rvdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: rvstart חייב להיות לפני rvend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: rvstart חייב להיות אחרי rvend.
- יכול לשמש רק עם דף בודד (mode #2).
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- rvuser
לכלול רק גרסאות מאת משתמש.
- יכול לשמש רק עם דף בודד (mode #2).
- סוג: שם משתמש
- rvexcludeuser
לא לכלול שינויים מאת משתמש.
- יכול לשמש רק עם דף בודד (mode #2).
- סוג: שם משתמש
- rvtag
לרשום רק גרסאות עם התג הזה.
- rvtoken
- מיושן.
אילו אסימונים לקבל עבור כל גרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): rollback
- rvcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבל נתונים על תוכן עבור הגרסאות האחרונות של הכותרות API ו־Main Page.
- api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content [פתיחה בארגז חול]
- קבלת 5 הגרסאות האחרונות של Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [פתיחה בארגז חול]
- קבלת 5 הגרסאות הראשונות של Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer [פתיחה בארגז חול]
- קבלת 5 הגרסאות הראשונות של Main Page שנעשו אחרי 2006-05-01.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z [פתיחה בארגז חול]
- קבלת 5 הגרבאות הראשונות של Main Page שלא נעשו על־ידי המשתמש האלמוני 127.0.0.1.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1 [פתיחה בארגז חול]
- קבלת 5 הגרסאות הראשונות של Main Page שנעשו על־ידי המשתמש MediaWiki default.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default [פתיחה בארגז חול]
prop=stashimageinfo (sii)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת מידע על הקובץ עבור הקבצים המוסלקים.
- siifilekey
מפתח שמזהה העלאה קודמת שהוסלקה באופן זמני.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- siisessionkey
- מיושן.
כינוי ל־siifilekey, לתאימות אחורה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- siiprop
איזה מידע על הקובץ לקבל:
- timestamp
- הוספת חותם־זמן לגרסה שהועלתה.
- canonicaltitle
- הוספת הכותרת הקנונית של הקובץ.
- url
- מתן URL לקובץ ולדף התיאור.
- size
- הוספת הגודל של הקובץ בבייטים והגובה, הרוחב ומניין הדפים (אם זה מתאים).
- dimensions
- כינוי ל־size.
- sha1
- הוספת גיבוב SHA-1 עבור הקובץ.
- mime
- הוספת סוג ה־MIME של הקובץ.
- thumbmime
- הוספת סוג ה־MIME של התמונה הממוזערת (נדרש url והפרמטר siiurlwidth).
- metadata
- טעינת מטא־נתונים של Exif עבור גרסת הקובץ.
- commonmetadata
- רשימת מטא־נתונים כלליים על תסדיר הקובץ עבור גרסת הקובץ.
- extmetadata
- רשימת מטא־נתונים מעוצבים משולבים ממספר מקורות. התוצאה מעוצבת ב־HTML.
- bitdepth
- הוספת עומק הביטים של הגרסה.
- badfile
- מוסיף האם הקובץ נמצא ב־MediaWiki:Bad image list
- ערכים (מופרדים באמצעות "|" או or תו חלופי): timestamp, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, metadata, commonmetadata, extmetadata, bitdepth, badfile
- ברירת מחדל: timestamp|url
- siiurlwidth
אם מוגדר siiprop=url, יוחזר URL לתמונה שגודלה הותאם לרוחב הזה. מסיבות של ביצועים, אם האפשרות הזאת משמשת, לא יוחזרו יותר מ־50 תמונות.
- סוג: מספר שלם
- ברירת מחדל: -1
- siiurlheight
דומה ל־siiurlwidth.
- סוג: מספר שלם
- ברירת מחדל: -1
- siiurlparam
מחרוזת פרמטר ייחודית למטפל. למשל, PDF־ים יכולים להשתמש ב־page15-100px. siiurlwidth צריך לשמש ולהיות עקבי עם siiurlparam.
- ברירת מחדל: (ריק)
- החזרת מידע על קובץ מוסלק.
- api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567 [פתיחה בארגז חול]
- החזרת תמונות ממוזערות עבור שני קבצים מוסלקים.
- api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url [פתיחה בארגז חול]
prop=templates (tl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת כל הדפים המוכללים בדפים הנתונים.
- tlnamespace
הצגת תבניות רק במרחב השם הזה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- tllimit
כמה תבניות להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- tlcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- tltemplates
לרשום רק את התבניות האלו. שימושי לבדיקה האם דף מסוים משתמש בתבנית מסוימת.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- tldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- קבלת התבניות המשמשות בדף Main Page.
- api.php?action=query&prop=templates&titles=Main%20Page [פתיחה בארגז חול]
- קבלת מידע על דפי התבנית שמשמשים ב־Main Page.
- api.php?action=query&generator=templates&titles=Main%20Page&prop=info [פתיחה בארגז חול]
- קבלת מידע במרחבי השם משתמש ו־תבנית שמוכללים בדף Main Page.
- api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [פתיחה בארגז חול]
prop=transcludedin (ti)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאת כל הדפים שמכלילים את הדפים הנתונים.
- tiprop
אילו מאפיינים לקבל:
- pageid
- מזהה הדף של כל דף.
- title
- השם של כל דף.
- redirect
- דגל אם הדף הוא הפניה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): pageid, title, redirect
- ברירת מחדל: pageid|title|redirect
- tinamespace
לכלול רק דפים במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- tishow
לחפש רק פריטים שמתאימים לאמות המידה הבאות:
- redirect
- להציג רק הפניות.
- !redirect
- לא להציג הפניות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): redirect, !redirect
- tilimit
כמה להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- ticontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- קבלת רשימה של דפים שמכלילים את Main Page.
- api.php?action=query&prop=transcludedin&titles=Main%20Page [פתיחה בארגז חול]
- קבלת מידע על הדפים שמכלילים את Main Page.
- api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info [פתיחה בארגז חול]
list=allcategories (ac)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות את כל הקטגוריות.
- acfrom
מאיזו קטגוריה להתחיל למנות.
- accontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- acto
באיזו קטגוריה להפסיק למנות.
- acprefix
חיפוש כל כותרות הקטגוריות שמתחילות בערך הזה.
- acdir
באיזה כיוון למיין.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- acmin
להחזיר רק קטגוריות עם מספר כזה לפחות של חברים.
- סוג: מספר שלם
- acmax
להחזיר רק קטגוריות עם מספר כזה לכל היותר של חברים.
- סוג: מספר שלם
- aclimit
כמה קטגוריות להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- acprop
אילו מאפיינים לקבל:
- size
- הוספת מספר הדפים בקטגוריה.
- hidden
- מתייג קטגוריות מוסתרות עם
__HIDDENCAT__.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): size, hidden
- ברירת מחדל: (ריק)
- רשימת קטגוריות עם מידע על מספר הדפים בכל אחת מהן.
- api.php?action=query&list=allcategories&acprop=size [פתיחה בארגז חול]
- אחזור מידע על דף הקטגוריה עצמו עבור קטגוריות שמתחילות ב־List.
- api.php?action=query&generator=allcategories&gacprefix=List&prop=info [פתיחה בארגז חול]
list=alldeletedrevisions (adr)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת כל הגרסאות המחוקות על־ידי משתמש או במרחב.
- adrprop
אילו מאפיינים לקבל עבור כל גרסה:
- ids
- מזהה הגרסה.
- flags
- דגלי גרסה (משני).
- timestamp
- חותם־הזמן של הגרסה.
- user
- המתמש שעשה את הגרסה
- userid
- מזהה המשתמש של יוצר הגרסה.
- size
- אורך (בבייטים) של הגרסה.
- sha1
- SHA-1 (בבסיס 16) של הגרסה.
- contentmodel
- מזהה מודל התוכן של הגרסה.
- comment
- הערה מאת המשתמש על הגרסה.
- parsedcomment
- הערה מפוענחת מאת המשתמש על הגרסה.
- content
- הטקסט של הגרסה.
- tags
- התגים עבור הגרסה.
- parsetree
- עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן
wikitext).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
- ברירת מחדל: ids|timestamp|flags|comment|user
- adrlimit
הגבלת מספר הגרסאות שיוחזרו.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- adrexpandtemplates
להרחיב תבניות בתוכן הגרסה (דורש adrprop=content).
- סוג: בוליאני (פרטים)
- adrgeneratexml
- מיושן.
יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את adrprop=content; מוחלף ב־adrprop=parsetree).
- סוג: בוליאני (פרטים)
- adrparse
פענוח תוכן הגרסה (דורש adrprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, adrlimit נכפה לערך 1.
- סוג: בוליאני (פרטים)
- adrsection
לאחזר רק את התוכן של הפִסקה עם המספר הזה.
- adrdiffto
מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.
- adrdifftotext
הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את adrdiffto. אם מוגדר adrsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.
- adrdifftotextpst
ביצוע התמרה לפני שמירה על הטקסט לפני הרצת השוואה. תקף רק כשמשמש עם adrdifftotext.
- סוג: בוליאני (פרטים)
- adrcontentformat
תסדיר ההסדרה שמשמש את adrdifftotext וצפוי לפלט של תוכן.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- adruser
לרשום רק גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- adrnamespace
לרשום רק דפים במרחב השם הזה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- adrstart
מאיזה חותם־זמן להתחיל למנות.
- יכול לשמש רק adruser.
- סוג: חותם־זמן (תסדירים מורשים)
- adrend
באיזה חותם־זמן להפסיק למנות.
- יכול לשמש רק adruser.
- סוג: חותם־זמן (תסדירים מורשים)
- adrdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: adrstart חייב להיות לפני adrend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: adrstart חייב להיות אחרי adrend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- adrfrom
להתחיל את הרשימה בשם הזה.
- לא יכול לשמש עם adruser.
- adrto
להפסיק את הרשימה בכותרת הזאת.
- לא יכול לשמש עם adruser.
- adrprefix
חיפוש כל שמות הדפים שמתחילים בערך הזה.
- לא יכול לשמש עם adruser.
- adrexcludeuser
לא לרשום גרסאות מאת המשתמש הזה.
- לא יכול לשמש עם adruser.
- סוג: שם משתמש
- adrtag
לרשום רק גרסאות עם התג הזה.
- adrcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- adrgeneratetitles
בעת שימוש בתור מחולל, לחולל כותרת במקום מזהי גרסה.
- סוג: בוליאני (פרטים)
- לרשום את 50 התרומות המחוקות האחרונות של משתמש Example.
- api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [פתיחה בארגז חול]
- רשימת 50 הגרסאות המחוקות הראשונות במרחב הראשי.
- api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [פתיחה בארגז חול]
list=allfileusages (af)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לרשום את כל שימושי הקובץ, כולל בלתי־קיימים.
- afcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- affrom
מאיזה שם קובץ להתחיל למנות.
- afto
שם הקובץ שהמנייה תסתיים בו.
- afprefix
חיפוש כל שמות הקבצים שמתחילים עם הערך הזה.
- afunique
להציג רק שמות קבצים ייחודיים. לא יכול לשמש עם afprop=ids. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.
- סוג: בוליאני (פרטים)
- afprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהי הדף של הדפים המשתמשים (לא יכול לשמש עם afunique).
- title
- הוספת שם הקובץ.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title
- ברירת מחדל: title
- aflimit
כמה פריטים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- afdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- רשימת שמות קבצים, כולל חסרים, עם מזהי הדפים שהם מופיעים בהם, החל מ־B.
- api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [פתיחה בארגז חול]
- רשימת שמות קבצים ייחודיים.
- api.php?action=query&list=allfileusages&afunique=&affrom=B [פתיחה בארגז חול]
- קבלת כל שמות הקבצים, כולל חסרים.
- api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [פתיחה בארגז חול]
- קבלת דפים שמכילים את הקבצים.
- api.php?action=query&generator=allfileusages&gaffrom=B [פתיחה בארגז חול]
list=allimages (ai)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות את כל התמונות לפי הסדר.
- aisort
לפי איזה מאפיין למיין.
- אחד מהערכים הבאים: name, timestamp
- ברירת מחדל: name
- aidir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending, newer, older
- ברירת מחדל: ascending
- aifrom
מאיזה שם תמונה להתחיל למנות. יכול לשמש רק עם aisort=name.
- aito
כותרת תמונה שבה תסתיים המניי. יכול לשמש רק עם aisort=name.
- aicontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- aistart
מאיזה חותם־זמן להתחיל למנות. יכול לשמש רק עם aisort=timestamp.
- סוג: חותם־זמן (תסדירים מורשים)
- aiend
באיזה חותם זמן להפסיק לרשום. אפשר להשתמש בזה רק עם aisort=timestamp.
- סוג: חותם־זמן (תסדירים מורשים)
- aiprop
איזה מידע על הקובץ לקבל:
- timestamp
- הוספת חותם־זמן לגרסה שהועלתה.
- user
- הוספה המשתמש שהעלה כל גרסה של קובץ.
- userid
- הוספת מזהה המשתמש שהעלה כל גרסה של קובץ.
- comment
- תגובה על הגרסה.
- parsedcomment
- פענוח ההערה על גרסה.
- canonicaltitle
- הוספת הכותרת הקנונית של הקובץ.
- url
- מתן URL לקובץ ולדף התיאור.
- size
- הוספת הגודל של הקובץ בבייטים והגובה, הרוחב ומניין הדפים (אם זה מתאים).
- dimensions
- כינוי ל־size.
- sha1
- הוספת גיבוב SHA-1 עבור הקובץ.
- mime
- הוספת סוג ה־MIME של הקובץ.
- mediatype
- הוספת סוג המדיה של הקובץ.
- metadata
- טעינת מטא־נתונים של Exif עבור גרסת הקובץ.
- commonmetadata
- רשימת מטא־נתונים כלליים על תסדיר הקובץ עבור גרסת הקובץ.
- extmetadata
- רשימת מטא־נתונים מעוצבים משולבים ממספר מקורות. התוצאה מעוצבת ב־HTML.
- bitdepth
- הוספת עומק הביטים של הגרסה.
- badfile
- מוסיף האם הקובץ נמצא ב־MediaWiki:Bad image list
- ערכים (מופרדים באמצעות "|" או or תו חלופי): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth, badfile
- ברירת מחדל: timestamp|url
- aiprefix
חיפוש כל שמות התמונות שמתחילים בערך הזה. יכול לשמש רק עם aisort=name.
- aiminsize
להגביל לתמונות עם מספר כזה של בייטים לפחות.
- סוג: מספר שלם
- aimaxsize
להגביל לתמונות עם מספר כזה לכל היותר של בייטים.
- סוג: מספר שלם
- aisha1
גיבוב SHA1 של תמונה. דריסת aisha1base36.
- aisha1base36
גיבוב SHA1 של התמונה בבסיס 36 (הבסיס בו נעשה שימוש במדיה־ויקי).
- aiuser
להחזיר רק קבצים שהועלו על־ידי המשתמש הזה. יכול לשמש רק עם aisort=timestamp. לא יכול לשמש יחד עם aifilterbots.
- סוג: שם משתמש
- aifilterbots
איך לסנן קבצים שמעלים בוטים. יכול לשמש רק עם aisort=timestamp. לא יכול לשמש יחד עם aiuser.
- אחד מהערכים הבאים: all, bots, nobots
- ברירת מחדל: all
- aimime
אילו סוגי MIME לחבפש, למשל image/jpeg.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ailimit
כמה תמונות להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- הצגת רשימה של קבצים שמתחילים באות B.
- api.php?action=query&list=allimages&aifrom=B [פתיחה בארגז חול]
- הצגת רשימת קבצים שהועלו לאחרונה, דומה ל־Special:NewFiles.
- api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older [פתיחה בארגז חול]
- להציג רשימה של קבצות שסוג ה־MIME שלהם הוא image/png או image/gif.
- api.php?action=query&list=allimages&aimime=image/png|image/gif [פתיחה בארגז חול]
- הצגת מידע על 4 קבצים המתחילים באות T.
- api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [פתיחה בארגז חול]
list=alllinks (al)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות את כל הקישורים שמצביעים למרחב שם נתון.
- alcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- alfrom
מאיזה שם קישור להתחיל למנות.
- alto
כותרת הקישור שהמנייה תסתיים בו.
- alprefix
חיפוש כל הכותרות המקושרות שמתחילות בערך הזה.
- alunique
להציג רק שמות מקושרים ייחודיים. לא יכול לשמש עם alprop=ids. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.
- סוג: בוליאני (פרטים)
- alprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהי הדף של הדף המקשר (לא יכול לשמש עם alunique).
- title
- הוספת שם הקישור.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title
- ברירת מחדל: title
- alnamespace
איזה מרחב שם למנות.
- אחד מהערכים הבאים: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- ברירת מחדל: 0
- allimit
כמה פריטים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- aldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- רשימת כותרות מקושרות, כולל חסרות, עם מזהי הדפים שהן מופיעות בהם, החל מ־B.
- api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [פתיחה בארגז חול]
- רשימת כותרות מקושרים ייחודיות.
- api.php?action=query&list=alllinks&alunique=&alfrom=B [פתיחה בארגז חול]
- קבלת כל הכותרות המקושרות, וסימון החסרות.
- api.php?action=query&generator=alllinks&galunique=&galfrom=B [פתיחה בארגז חול]
- קבלת דפים שמכילים את הקישורים.
- api.php?action=query&generator=alllinks&galfrom=B [פתיחה בארגז חול]
list=allpages (ap)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות את כל הדפים לפי הסדר במרחב שם נתון.
- apfrom
מאיזה שם דף להתחיל למנות.
- apcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- apto
כותרת הדף שהמנייה תסתיים בו.
- apprefix
חיפוש כל שמות הדפים שמתחילים בערך הזה.
- apnamespace
איזה מרחב שם למנות.
- אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- ברירת מחדל: 0
- apfilterredir
אילו דפים לרשום.
- אחד מהערכים הבאים: all, redirects, nonredirects
- ברירת מחדל: all
- apminsize
להגביל לדפים עם מספר כזה לפחות של בייטים.
- סוג: מספר שלם
- apmaxsize
להגביל לדפים שיש בהם לכל היותר מספר כזה של בייטים.
- סוג: מספר שלם
- apprtype
להגביל רק לדפים מוגנים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): edit, move, upload
- apprlevel
לסנו הגנות לפי רמת ההגנה (חייב לשמש עם apprtype= parameter).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): יכול להיות ריק או autoconfirmed, sysop
- apprfiltercascade
לסנן הגנות לפי דירוגיות (לא תקף כאשר apprtype אינו מוגדר).
- אחד מהערכים הבאים: cascading, noncascading, all
- ברירת מחדל: all
- aplimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- apdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- apfilterlanglinks
סינון על סמך קיום קישורים לשוניים בדף. יש לשים לב לכך שזה אולי לא יתייחס לקישורים לשוניים שנוספו על־ידי הרחבות.
- אחד מהערכים הבאים: withlanglinks, withoutlanglinks, all
- ברירת מחדל: all
- apprexpiry
לפי איזו תפוגת הגנה לסנן את הדף הזה:
- indefinite
- לקבל רק דפים מוגנית לצמיתות.
- definite
- לקבל רק דפים עם תפוגת הגנה מוגדרת.
- all
- לקבל דפים עם תפוגת הגנה כלשהי.
- אחד מהערכים הבאים: indefinite, definite, all
- ברירת מחדל: all
- להציג רשימה של דפים במתחילים באות B.
- api.php?action=query&list=allpages&apfrom=B [פתיחה בארגז חול]
- להציג מידע על 4 דפים שמתחילים באות T.
- api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [פתיחה בארגז חול]
- להציג את תוכן של 2 הדפים הראשונים שמתחילים ב־Re ושאינם דפי הפניה.
- api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [פתיחה בארגז חול]
list=allredirects (ar)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימה של כל ההפניות למרחב שם.
- arcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- arfrom
מאיזו כותרת הפניה להתחיל את מנייה.
- arto
כותרת ההפניה שהמנייה תיפסק בה.
- arprefix
חיפוש על דפי היעד שמתחילים בערך הזה.
- arunique
להציג רק דפים ייחודיים. לא יכול לשמש עם arprop=ids|fragment|interwiki. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.
- סוג: בוליאני (פרטים)
- arprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהה הדף של הדף המפנה (לא יכול לשמש עם arunique).
- title
- הוספת כותרת ההפניה.
- fragment
- הוספת המובאה מההפניה, אם יש (לא יכול לשמש עם arunique).
- interwiki
- הוספת תחילית הבינוויקי מההפניה, אם יש (לא יכול לשמש עם arunique).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, fragment, interwiki
- ברירת מחדל: title
- arnamespace
איזה מרחב שם למנות.
- אחד מהערכים הבאים: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- ברירת מחדל: 0
- arlimit
כמה פריטים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- ardir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- רשימת דפי יעד, כולל חסרים, עם מזהי הדפים שהם מופיעים בהם, החל מ־B.
- api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [פתיחה בארגז חול]
- רשימת דפי יעד ייחודיים.
- api.php?action=query&list=allredirects&arunique=&arfrom=B [פתיחה בארגז חול]
- קבלת על דפי היעד, תוך כדי סימון החסרים.
- api.php?action=query&generator=allredirects&garunique=&garfrom=B [פתיחה בארגז חול]
- קבלת דפים שמכילים את ההפניות.
- api.php?action=query&generator=allredirects&garfrom=B [פתיחה בארגז חול]
list=allrevisions (arv)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת כל הגרסאות.
- arvprop
אילו מאפיינים לקבל עבור כל גרסה:
- ids
- מזהה הגרסה.
- flags
- דגלי גרסה (משני).
- timestamp
- חותם־הזמן של הגרסה.
- user
- המתמש שעשה את הגרסה
- userid
- מזהה המשתמש של יוצר הגרסה.
- size
- אורך (בבייטים) של הגרסה.
- sha1
- SHA-1 (בבסיס 16) של הגרסה.
- contentmodel
- מזהה מודל התוכן של הגרסה.
- comment
- הערה מאת המשתמש על הגרסה.
- parsedcomment
- הערה מפוענחת מאת המשתמש על הגרסה.
- content
- הטקסט של הגרסה.
- tags
- התגים עבור הגרסה.
- parsetree
- עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן
wikitext).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
- ברירת מחדל: ids|timestamp|flags|comment|user
- arvlimit
הגבלת מספר הגרסאות שיוחזרו.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- arvexpandtemplates
להרחיב תבניות בתוכן הגרסה (דורש arvprop=content).
- סוג: בוליאני (פרטים)
- arvgeneratexml
- מיושן.
יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את arvprop=content; מוחלף ב־arvprop=parsetree).
- סוג: בוליאני (פרטים)
- arvparse
פענוח תוכן הגרסה (דורש arvprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, arvlimit נכפה לערך 1.
- סוג: בוליאני (פרטים)
- arvsection
לאחזר רק את התוכן של הפִסקה עם המספר הזה.
- arvdiffto
מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.
- arvdifftotext
הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את arvdiffto. אם מוגדר arvsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.
- arvdifftotextpst
ביצוע התמרה לפני שמירה על הטקסט לפני הרצת השוואה. תקף רק כשמשמש עם arvdifftotext.
- סוג: בוליאני (פרטים)
- arvcontentformat
תסדיר ההסדרה שמשמש את arvdifftotext וצפוי לפלט של תוכן.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- arvuser
לרשום רק גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- arvnamespace
לרשום רק דפים במרחב השם הזה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- arvstart
מאיזה חותם־זמן להתחיל למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- arvend
באיזה חותם־זמן להפסיק למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- arvdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: arvstart חייב להיות לפני arvend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: arvstart חייב להיות אחרי arvend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- arvexcludeuser
לא לרשום גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- arvcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- arvgeneratetitles
בעת שימוש בתור מחולל, לחולל כותרת במקום מזהי גרסה.
- סוג: בוליאני (פרטים)
- לרשום את 50 התרומות האחרונות של משתמש Example.
- api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [פתיחה בארגז חול]
- רשימת 50 הגרסאות הראשונות במרחב הראשי.
- api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [פתיחה בארגז חול]
list=alltransclusions (at)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת כל ההכללות (דפים שמוטבעים באמצעות {{x}}), כולל כאלה שאינם קיימים.
- atcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- atfrom
מאיזו כותרת ההכללה להתחיל למנות.
- atto
כותרת ההכללה שהמנייה תיפסק בה.
- atprefix
חיפוש כל הכותרות המוכללות שמתחילות הערך הזה.
- atunique
להציג רק שמות מוכללים ייחודיים. לא יכול לשמש עם atprop=ids. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.
- סוג: בוליאני (פרטים)
- atprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהי הדף של הדפים המכלילים (לא יכול לשמש עם atunique).
- title
- הוספת כותרת ההכללה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title
- ברירת מחדל: title
- atnamespace
איזה מרחב שם למנות.
- אחד מהערכים הבאים: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- ברירת מחדל: 10
- atlimit
כמה פריטים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- atdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- רשימת כותרות מוכללות, כולל חסרות, עם מזהי הדפים שהן מופיעות בהם, החל מ־B.
- api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [פתיחה בארגז חול]
- רשימת כותרת מוכללות ייחודיות.
- api.php?action=query&list=alltransclusions&atunique=&atfrom=B [פתיחה בארגז חול]
- קבלת כל כל הכותרות המוכללות, תוך כדי סימון החסרות.
- api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [פתיחה בארגז חול]
- קבלת דפים שמכילים את ההכללות.
- api.php?action=query&generator=alltransclusions&gatfrom=B [פתיחה בארגז חול]
list=allusers (au)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות את כל המשתמשים הרשומים.
- aufrom
מאיזה שם משתמש להתחיל למנות.
- auto
באיזה שם משתמש להפסיק למנות.
- auprefix
חיפוש כל המשתמשים שמתחילים בערך הזה.
- audir
באיזה כיוון למיין.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- augroup
לכלול רק משתמשים בקבוצות הנתונות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): bot, sysop, bureaucrat
- auexcludegroup
לא לכלול משתמשים בקבוצות הנתונות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): bot, sysop, bureaucrat
- aurights
לכלול רק משתמשים עם ההרשאות הנתונות. לא כולל הרשאות שניתנו בקבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 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, editmyuserjs, editmywatchlist, editsemiprotected, editusercss, 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
- מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- auprop
אילו פרטי מידע לכלול:
- blockinfo
- הוספת מידע עם החסימה הנוכחית של משתמש.
- groups
- הוספת קבוצות שמשתמש חבר בהן. זה משתמש ביותר משאבי דפדפן ויכול להחזיר פחות תוצאות מהמגבלה.
- implicitgroups
- לרשום את כל הקבוצות שהמשתמש חבר בהן אוטומטית.
- rights
- רשימת הההרשאות שיש למשתמש.
- editcount
- הוספת מונה העריכות של המשתמש.
- registration
- הוספת חותם־הזמן של זמן הרישום של המשתמש (יכול להיות ריק).
- centralids
- הוספת המזהה המרכזי ומצב השיוך למשתמש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): blockinfo, groups, implicitgroups, rights, editcount, registration, centralids
- aulimit
כמה שמות משתמש בסך הכול לשנות.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- auwitheditsonly
לרשום רק משתמשים שעשו עריכות.
- סוג: בוליאני (פרטים)
- auactiveusers
לרשום רק משתמשים שהיו פעילים ב־30 הימים האחרונים.
- סוג: בוליאני (פרטים)
- auattachedwiki
עם auprop=centralids, לציין גם האם המשתמש משויך לוויקי עם המזהה הזה.
- לרשום משתמשים שמתחילים ב־Y.
- api.php?action=query&list=allusers&aufrom=Y [פתיחה בארגז חול]
list=backlinks (bl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאת כל הדפים שמקשרים לדף הנתון.
- bltitle
איזו כותרת לחפש. לא ניתן להשתמש בזה יחד עם blpageid.
- blpageid
מזהה דף לחיפוש. לא ניתן להשתמש בזה יחד עם bltitle.
- סוג: מספר שלם
- blcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- blnamespace
איזה מרחב שם למנות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- bldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- blfilterredir
איך לסנן הפניות. אם זה מוגדר ל־nonredirects כש־blredirect מופעל, זה חל רק על הרמה השנייה.
- אחד מהערכים הבאים: all, redirects, nonredirects
- ברירת מחדל: all
- bllimit
כמה דפים להחזיר בסך הכול. אם blredirect מופעל, ההגבלה חלה על כל רמה בנפרד (כלומר יכולות להיות מוחזרות עד 2 * bllimit תוצאות).
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- blredirect
אם הדף המקשר הוא הפניה, למצוא גם את כל הדפים שמקשרים לאותה ההפניה. ההגבלה המרבית מוקטנת בחצי.
- סוג: בוליאני (פרטים)
- הצגת קישורים ל־Main Page.
- api.php?action=query&list=backlinks&bltitle=Main%20Page [פתיחה בארגז חול]
- קבל מידע על דפים שמקשרים ל־Main page.
- api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info [פתיחה בארגז חול]
list=blocks (bk)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לרשום את כל המשתמשים וכתובות ה־IP שנחסמו.
- bkstart
מאיזה חותם־זמן להתחיל למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- bkend
באיזה חותם זמן להפסיק למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- bkdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: bkstart חייב להיות לפני bkend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: bkstart חייב להיות אחרי bkend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- bkids
רשימת מזהי חסימות לרשום (לא חובה).
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- bkusers
רשימת משתמשים לחיפוש (לא חובה).
- סוג: רשימת שמות משתמשים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- bkip
קבלת כל החסימות שחלות על טווח ה־IP או ה־CIDR הזה, כולל חסימות טווח. לא יכול לשמש יחד עם bkusers. טווחי CIDR רחבים מ־IPv4/16 או IPv6/19 אינם מתקבלים.
- bklimit
המספר המרבי של חסימות לרשום.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- bkprop
אילו מאפיינים לקבל:
- id
- הוספת מזהה החסימה.
- user
- הוספת שם המשתמש שנחסם.
- userid
- הוספת המזהה של המשמש שנחסם.
- by
- הוספת שם המשתמש שחסם.
- byid
- הוספת מזהה המשתמש שחסם.
- timestamp
- הוספת חותם־הזמן של החסימה.
- expiry
- הוספת חותם־הזמן של תפוגת החסימה.
- reason
- הוספת הסיבה שניתנה לחסימה.
- range
- הוספת טווח כתובות ה־IP שהחסימה משפיעה עליהן.
- flags
- מתייג את ההחרמה (autoblock, anononly, וכו'.).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
- ברירת מחדל: id|user|by|timestamp|expiry|reason|flags
- bkshow
להציג רק פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק חסימות ללא לצמיתות על כתובות IP יש להגדיר bkshow=ip|!temp.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): account, !account, temp, !temp, ip, !ip, range, !range
- bkcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- רשימת חסימות.
- api.php?action=query&list=blocks [פתיחה בארגז חול]
- רשימת חסימות של המשתמשים Alice ו־Bob.
- api.php?action=query&list=blocks&bkusers=Alice|Bob [פתיחה בארגז חול]
list=categorymembers (cm)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת כל הדפים בקטגוריה נתונה.
- cmtitle
איזו קטגוריה למנות (נדרש). חייב לכלול את התחילית קטגוריה:. לא יכול לשמש יחד עם cmpageid.
- cmpageid
מזהה הדף של הקטגוריה שצריך למנות. לא יכול לשמש יחד עם cmtitle.
- סוג: מספר שלם
- cmprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהה הדף.
- title
- הוספת השם ומזהה מרחב השם של הדף.
- sortkey
- הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרזות הקסדצימלית).
- sortkeyprefix
- הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרוזת הקסדצימלית).
- type
- הוספת הסוג שהדף מוין אליו (page, subcat או file).
- timestamp
- הוספת חותם־הזמן שבו הדף נכלל.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, sortkey, sortkeyprefix, type, timestamp
- ברירת מחדל: ids|title
- cmnamespace
לכלול רק דפים במרחבי השם האלה. יש לשים לב לכך ש־cmtype=subcat או cmtype=file יכולים לשמש במקום cmnamespace=14 או 6.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- cmtype
איזה סוג של חברי קטגוריה לכלול. לא תקף כאשר מוגדר cmsort=timestamp.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): page, subcat, file
- ברירת מחדל: page|subcat|file
- cmcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- cmlimit
מספר הדפים המרבי שיוחזר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- cmsort
לפי איזה מאפיין למיין.
- אחד מהערכים הבאים: sortkey, timestamp
- ברירת מחדל: sortkey
- cmdir
באיזה כיוון למיין.
- אחד מהערכים הבאים: asc, desc, ascending, descending, newer, older
- ברירת מחדל: ascending
- cmstart
מאיזה חותם־זמן להתחיל לרשום. יכול לשמש רק עם cmsort=timestamp.
- סוג: חותם־זמן (תסדירים מורשים)
- cmend
באיזה חותם־זמן לסיים לרשום. יכול לשמש רק עם cmsort=timestamp.
- סוג: חותם־זמן (תסדירים מורשים)
- cmstarthexsortkey
מפתח מיון להתחיל לרשום ממנו, כפי שמוחזר על־ידי cmprop=sortkey</kbd. יכול לשמש רק עם cmsort=sortkey.
- cmendhexsortkey
מפתח מיון לסיים לרשום ממנו, כפי שמוחזר על־ידי cmprop=sortkey. יכול לשמש רק עם cmsort=sortkey.
- cmstartsortkeyprefix
תחילית מפתח מיון להתחיל לרשום ממנה. יכול לשמש רק עם cmsort=sortkey. דורס את cmstarthexsortkey.
- cmendsortkeyprefix
תחילית מפתח מיון שהרשימה תסתיים לפניה (לא בה, אם הערך הזה מוגדר, הוא לא ייכלל!). יכול לשמש רק עם cmsort=sortkey. דורס את cmendhexsortkey.
- cmstartsortkey
- מיושן.
כדאי להשתמש ב־cmstarthexsortkey במקום.
- cmendsortkey
- מיושן.
כדאי להשתמש ב־cmendhexsortkey במקום.
- קבלת עשרת העמודים הראשונים שתחת Category:Physics.
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics [פתיחה בארגז חול]
- קבל מידע על הדף עבור 10 הדפים הראשונים ב־Category:Physics.
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [פתיחה בארגז חול]
list=deletedrevs (dr)
- יחידה זו אינה מומלצת לשימוש.
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת גרסאות מחוקות.
פועל בשלושה אופנים:
- רשימת גרסאות מחוקות לשמות שניתנו, ממוינות לפי חותם־זמן.
- רשימת תרומות מחוקות של המשתמש שניתן, ממוינות לפי חותם־זמן (בלי לציין שמות).
- רשימת כל הגרסאות המחוקות במרחב השם שניתן, ממוינות לפי שם וחותם־זמן (בלי לציין שמות, בלי להגדיר druser).
פרמטרים מסוימים חלים רק על חלק מהאופנים ולא תקפים באחרים.
- drstart
באיזה חותם־זמן להתחיל למנות.
- מצבים: 1, 2
- סוג: חותם־זמן (תסדירים מורשים)
- drend
באיזה חותם־זמן להפסיק למנות.
- מצבים: 1, 2
- סוג: חותם־זמן (תסדירים מורשים)
- drdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: drstart חייב להיות לפני drend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: drstart חייב להיות אחרי drend.
- מצבים: 1, 3
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- drfrom
להתחיל את הרשימה בשם הזה.
- מצב: 3
- drto
להפסיק את הרשימה בכותרת הזאת.
- מצב: 3
- drprefix
חיפוש כל שמות הדפים שמתחילים בערך הזה.
- מצב: 3
- drunique
לרשום רק גרסה אחת עבור כל דף.
- מצב: 3
- סוג: בוליאני (פרטים)
- drnamespace
לרשום רק דפים במרחב השם הזה.
- מצב: 3
- אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- ברירת מחדל: 0
- drtag
לרשום רק גרסאות עם התג הזה.
- druser
לרשום רק גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- drexcludeuser
לא לרשום גרסאות מאת המשתמש הזה.
- סוג: שם משתמש
- drprop
אילו מאפיינים לקבל:
- revid
- הוספת מזהה הגרסה של הגרסה המחוקה.
- parentid
- הוספת מזהה הגרסה של הגרסה הקודמת של הדף.
- user
- הוספת המשתמש שעשה את הגרסה.
- userid
- הוספת מזהה המשתמש שעשה את הגרסה.
- comment
- הוספת ההערה על הגרסה.
- parsedcomment
- הוספת ההערה המפוענחת על הגרסה.
- minor
- מתייג אם הגרסה משנית.
- len
- מוסיף את האורך (בבייטים) של הגרסה.
- sha1
- הוספת ה־SHA-1 (בסיס 16) של הגרסה.
- content
- הוספת התוכן של הגרסה.
- token
- מיושן. נותן אסימון עריכה.
- tags
- תגים עבור הגרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags
- ברירת מחדל: user|comment
- drlimit
המספר המרבי של הגרסאות שיירשם.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- drcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- רשימת כל הגרסאות המחוקות של הדפים Main Page ו־Talk:Main Page, עם תוכן (mode 1).
- api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [פתיחה בארגז חול]
- רשימת 50 העריכות המחוקות האחרונות של Bob (mode 2).
- api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [פתיחה בארגז חול]
- רשימת 50 הגרסאות המחוקות הראשונות במרחב הראשי (mode 3).
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [פתיחה בארגז חול]
- רשימת 50 הדפים המחוקים הראשונים במרחב השם שיחה (mode 3).
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [פתיחה בארגז חול]
list=embeddedin (ei)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
חיפוש כל הדפים שמטמיעים (מכלילים) את הכותרת הנתונה.
- eititle
איזו כותרת לחפש. לא ניתן להשתמש בזה יחד עם eipageid.
- eipageid
מזהה דף לחיפוש. לא יכול לשמש יחד עם eititle.
- סוג: מספר שלם
- eicontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- einamespace
איזה מרחב שם למנות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- eidir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- eifilterredir
איך לסנן עבור הפניות.
- אחד מהערכים הבאים: all, redirects, nonredirects
- ברירת מחדל: all
- eilimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- הצגת דפים שמכלילים את Template:Stub.
- api.php?action=query&list=embeddedin&eititle=Template:Stub [פתיחה בארגז חול]
- קבלת מידע על דפים שמכלילים את Template:Stub.
- api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [פתיחה בארגז חול]
list=exturlusage (eu)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות דפים שמכילים URL נתון.
- euprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהה הדף.
- title
- הוספת השם ומזהה מרחב השם של הדף.
- url
- הוספת ה־URL שמשמש בדף.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, url
- ברירת מחדל: ids|title|url
- euoffset
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- סוג: מספר שלם
- euprotocol
הפרוטוקול של ה־URL. אם זה ריק, ו־euquery מוגדר, הפרוטוקול הוא http. יש להשאיר את זה ואת euquery ריק כדי לרשום את כל הקישורים החיצוניים.
- אחד מהערכים הבאים: יכול להיות ריק או 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
- ברירת מחדל: (ריק)
- euquery
מחרוזת חיפוש ללא פרוטוקל. ר' Special:LinkSearch. יש להשאיר את זה ריק כדי לרשום את כל הקישורים החיצוניים.
- eunamespace
איזה מרחב שם למנות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- eulimit
כמה דפים להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- euexpandurl
הרחבת URL־ים בעלי פרוטוקול יחסי בפרוטוקול קנוני.
- סוג: בוליאני (פרטים)
list=filearchive (fa)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות את כל הקבצים המחוקים לפי הסדר.
- fafrom
מאיזו כותרת תמונה להתחיל למנות.
- fato
באיזו כותרת תמונה להפסיק למנות.
- faprefix
חיפוש כל שמות התמונות שמתחילים בערך הזה.
- fadir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- fasha1
גיבוב SHA1 של תמונה. דורס את fasha1base36.
- fasha1base36
גיבוב SHA1 של תמונה בבסיס 36 (משמש במדיה־ויקי).
- faprop
איזה מידע על תמונה לקבל:
- sha1
- הוספת גיבוב SHA-1 עבור התמונה.
- timestamp
- הוספת חותם־זמן לגרסה המועלית.
- user
- הוספת המשתמש שהעלה על גרסת התמונה.
- size
- הוספת הגודל של התמונה בבייטים והגובה, הרוחב ומניין הדפים (אם מתאים).
- dimensions
- כינוי ל־size.
- description
- הוספת תיאור לגרסת התמונה.
- parseddescription
- פענוח התיאור של הגרסה.
- mime
- הוספת ה־MIME של התמונה.
- mediatype
- הוספת סוג המדיה של התמונה.
- metadata
- רשימת מטא־נתוני Exif עבור גרסת הקובץ.
- bitdepth
- הוספת עומק הביטים של הגרסה.
- archivename
- הוספת שם הקובץ של גרסה מאורכבת עבור גרסאות שאינן האחרונה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename
- ברירת מחדל: timestamp
- falimit
כמה תמונות להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- facontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- הצגת רשימת כל הקבצים המחוקים.
- api.php?action=query&list=filearchive [פתיחה בארגז חול]
list=imageusage (iu)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאת כל הדפים שמתמשים בשם התמונה הנתונה.
- iutitle
איזו כותרת לחפש. לא ניתן להשתמש בזה יחד עם iupageid.
- iupageid
מזהה דף לחיפוש. לא יכול לשמש יחד עם iutitle.
- סוג: מספר שלם
- iucontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- iunamespace
איזה מרחב שם למנות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- iudir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- iufilterredir
איך לסנן הפניות. אם זה מוגדר ל־nonredirects כש־iuredirect מופעל, זה חל רק על הרמה השנייה.
- אחד מהערכים הבאים: all, redirects, nonredirects
- ברירת מחדל: all
- iulimit
כמה דפים להחזיר בסך הכול. אם iuredirect מופעל, ההגבלה חלה על כל רמה בנפרד (כלומר יכולות להיות מוחזרות עד 2 * iulimit תוצאות).
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- iuredirect
אם הדף המקשר הוא הפניה, למצוא גם את כל הדפים שמקשרים לאותה ההפניה. ההגבלה המרבית מוקטנת בחצי.
- סוג: בוליאני (פרטים)
- הצגת דפים שמשתמשים ב־File:Albert Einstein Head.jpg.
- api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg [פתיחה בארגז חול]
- קבלת פרטים על דפים שמשתמשים ב־File:Albert Einstein Head.jpg.
- api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info [פתיחה בארגז חול]
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg){kind=link}
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info){kind=link}
list=iwbacklinks (iwbl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאות כל הדפים שמקשרים לקישור הבינוויקי הנתון.
יכול לשמש למציאת כל הקישורים עם התחילית, או כל הקישורים לכותרת (עם תחילית נתונה). אי־שימוש בשום פרמטר אומר "כל קישורי בינוויקי".
- iwblprefix
תחילית לבינוויקי.
- iwbltitle
איזה קישור בינוויקי לחפש. צריך להשתמש בזה יחד עם iwblblprefix.
- iwblcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- iwbllimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- iwblprop
אילו מאפיינים לקבל:
- iwprefix
- הוספת התחילית של הבינוויקי.
- iwtitle
- הוספת הכותרת של הבינוויקי.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): iwprefix, iwtitle
- ברירת מחדל: (ריק)
- iwbldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
list=langbacklinks (lbl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מציאת כל הדפים שמקשרים לקישור השפה הנתון.
יכול לשמש למציאת כל הקישורים עם קוד שפה, או כל הקישורים לכותרת (עם שפה נתונה). אי־שימוש בשום פרמטר פירושו "כל קישורי שפה".
נא לשים לב לכך שזה עשוי לא להתייחס לקישורי שפה שמוסיפות הרחבות.
- lbllang
שפה עבור קישור שפה.
- lbltitle
איזה קישור שפה לחפש. חייב לשמש עם lbllang.
- lblcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- lbllimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- lblprop
אילו מאפיינים לקבל:
- lllang
- הוספת קוד השפה של קישור השפה.
- lltitle
- הוספת הכותרת של קישור השפה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): lllang, lltitle
- ברירת מחדל: (ריק)
- lbldir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- קבלת דפים שמקשרים ל־fr:Test.
- api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr [פתיחה בארגז חול]
- קבלת מידע על דפים שמקשרים ל־fr:Test.
- api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info [פתיחה בארגז חול]
list=logevents (le)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת אירועים מהרישומים.
- leprop
אילו מאפיינים לקבל:
- ids
- הוספת המזהה של אירוע היומן.
- title
- הוספת שם הדף של אירוע היומן.
- type
- הוספת הסוג של אירוע היומן.
- user
- הוספת המשתמש האחראי על אירוע היומן.
- userid
- הוספת מזהה המשתמש האחראי על אירוע היומן.
- timestamp
- הוספת חותם־הזמן עבור האירוע.
- comment
- הוספת ההערה של האירוע.
- parsedcomment
- הוספת ההערה המפוענחת של האירוע.
- details
- הוספת פרטים נוספים על האירוע.
- tags
- רשימת התגים של האירוע.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags
- ברירת מחדל: ids|title|type|user|timestamp|comment|details
- letype
סינון עיולי יומן רק לסוג הזה.
- אחד מהערכים הבאים: יכול להיות ריק או block, protect, rights, delete, upload, move, import, patrol, merge, suppress, tag, managetags, contentmodel, newusers
- leaction
סינון פעולות יומן רק לפעולה הזאת. דורס את letype. ברשימת הערכים האפשריים, ערכים עם תו־כל כוכבית כגון action/* יכולים להיות מחרוזות שונות אחרי הקו הנטוי (/).
- אחד מהערכים הבאים: block/block, block/reblock, block/unblock, contentmodel/change, contentmodel/new, delete/delete, delete/delete_redir, delete/event, delete/restore, delete/revision, import/interwiki, import/upload, managetags/activate, managetags/create, managetags/deactivate, managetags/delete, merge/merge, move/move, move/move_redir, patrol/patrol, patrol/autopatrol, protect/modify, protect/move_prot, protect/protect, protect/unprotect, rights/autopromote, rights/rights, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, upload/overwrite, upload/revert, upload/upload, newusers/newusers, newusers/create, newusers/create2, newusers/byemail, newusers/autocreate
- lestart
מאיזה חותם־זמן להתחיל למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- leend
באיזה חותם זמן להפסיק לרשום.
- סוג: חותם־זמן (תסדירים מורשים)
- ledir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: lestart חייב להיות לפני leend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: lestart חייב להיות אחרי leend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- leuser
לסנן את העיולים שעשה המשתמש הנתון.
- סוג: שם משתמש
- letitle
סינון עיולים רק לכאלה שמתייחסים לדף.
- lenamespace
סינון עיולים רק לכאלה במרחב השם הנתון.
- אחד מהערכים הבאים: -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- leprefix
סינון עיולים לכאלה שמתחילים עם התחילית הזאת.
- letag
לרשום רק אירועים שמתויגם בתג הזה.
- lelimit
כמה עיולי אירועים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- lecontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- רשימת אירועי יומן אחרונים.
- api.php?action=query&list=logevents [פתיחה בארגז חול]
list=mystashedfiles (msf)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת רשימת קבצים בסליק ההעלאה של המשתמש הנוכחי.
- msfprop
אילו מאפיינים לאחזר עבור הקבצים.
- size
- אחזור גודל הקובץ וממדי התמונה.
- type
- אחזור סוג ה־MIME של הקובץ וסוג המדיה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): size, type
- ברירת מחדל: (ריק)
- msflimit
כמה קבצים לקבל.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- msfcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- לקבל מפתח קובץ, גודל קובץ וגודל בפיקסלים של קבצים בסליק ההעלאה של המשתמש הנוכחי.
- api.php?action=query&list=mystashedfiles&msfprop=size [פתיחה בארגז חול]
list=pagepropnames (ppn)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת כל שמות המאפיינים שמשמשים בוויקי.
- ppncontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- ppnlimit
המספר המרבי של השמות להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- לתת את 10 שמות המאפיינים הראשונים.
- api.php?action=query&list=pagepropnames [פתיחה בארגז חול]
list=pageswithprop (pwp)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לרשום את כל הדפים שמשתמשים במאפיין דף נתון.
- pwppropname
מאפיין דף שעבורו למנות דפים (action=query&list=pagepropnames מחזיר רשימת שמות מאפייני דף בשימוש).
- פרמטר זה נדרש.
- pwpprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהה הדף.
- title
- הוספת השם ומזהה מרחב השם של הדף.
- value
- הוספת הערך של מאפיין הדף.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, value
- ברירת מחדל: ids|title
- pwpcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- pwplimit
מספר הדפים המרבי שיוחזר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- pwpdir
באיזה כיוון לסדר.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- הצגת עשרת הדפים הראשונים שעושים שימוש ב־
{{DISPLAYTITLE:}}. - api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [פתיחה בארגז חול]
- קבלת מידע נוסף על עשרת הדפים הראשונים המשתמשים ב־
__NOTOC__. - api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [פתיחה בארגז חול]
list=prefixsearch (ps)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
ביצוע חיפוש תחילית של כותרות דפים.
למרות הדמיון בשם, המודול הזה אינו אמור להיות שווה ל־Special:PrefixIndex ("מיוחד:דפים המתחילים ב"); לדבר כזה, ר' action=query&list=allpages עם הפרמטר apprefix. מטרת המודול הזה דומה ל־action=opensearch: לקבל קלט ממשתמש ולספק את הכותרות המתאימות ביותר. בהתאם לשרת מנוע החיפוש, זה יכול לכלול תיקון שגיאות כתיב, הימנעות מדפי הפניה והירסטיקות אחרות.
- pssearch
מחרוזת לחיפוש.
- פרמטר זה נדרש.
- psnamespace
שמות מתחם לחיפוש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ברירת מחדל: 0
- pslimit
מספר התוצאות המרבי להחזרה.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- psoffset
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- סוג: מספר שלם
- ברירת מחדל: 0
- חיפוש שםות דפים שמתחילים ב־meaning.
- api.php?action=query&list=prefixsearch&pssearch=meaning [פתיחה בארגז חול]
list=protectedtitles (pt)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לרשום את כל הכותרות שמוגנות מפני יצירה.
- ptnamespace
לרשום רק כותרות במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ptlevel
לרשום רק שמות עם רמת ההגנה הזאת.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): autoconfirmed, sysop
- ptlimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- ptdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: ptstart חייב להיות לפני ptend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: ptstart חייב להיות אחרי ptend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- ptstart
להתחיל לרשום בחותם־זמן ההגנה הזה.
- סוג: חותם־זמן (תסדירים מורשים)
- ptend
באיזה חותם־זמן הגנה לסיים את הרשימה.
- סוג: חותם־זמן (תסדירים מורשים)
- ptprop
אילו מאפיינים לקבל:
- timestamp
- הוספת חותם־הזמן של הוספת ההגנה.
- user
- הוספת המשתמש שהוסיף את ההגנה.
- userid
- הוספת מזהה המשתמש שהוסיף את ההגנה.
- comment
- הוספת ההערה עבור ההגנה.
- parsedcomment
- הוספת ההערה המפוענחת עבור ההגנה.
- expiry
- הוספת חותם־הזמן של הסרת ההגנה.
- level
- הוספת רמת ההגנה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): timestamp, user, userid, comment, parsedcomment, expiry, level
- ברירת מחדל: timestamp|level
- ptcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- רשימת כותרות מוגנות.
- api.php?action=query&list=protectedtitles [פתיחה בארגז חול]
- חיפוש קישורים לכותרות מוגנות במרחב הראשי.
- api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere [פתיחה בארגז חול]
list=querypage (qp)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת רשימה שמסופקת על־ידי דף מיוחד מבוסס־QueryPage.
- qppage
שם הדף המיוחד. לתשומת לבך, זה תלוי־רישיות.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: Ancientpages, BrokenRedirects, Deadendpages, DoubleRedirects, ListDuplicatedFiles, Listredirects, Lonelypages, Longpages, MediaStatistics, Mostcategories, Mostimages, Mostinterwikis, Mostlinkedcategories, Mostlinkedtemplates, Mostlinked, Mostrevisions, Fewestrevisions, Shortpages, Uncategorizedcategories, Uncategorizedpages, Uncategorizedimages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Unwatchedpages, Unusedtemplates, Withoutinterwiki
- qpoffset
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- סוג: מספר שלם
- ברירת מחדל: 0
- qplimit
מספר תוצאות להחזרה.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
list=random (rn)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת ערכת דפים אקראיים.
הדפים רשומים בסדר קבוע, ורק נקודת ההתחלה אקראית. זה אומר שאם, למשל, Main Page הוא הדף האקראי הראשון הרשימה, List of fictional monkeys יהיה תמיד השני, List of people on stamps of Vanuatu שלישי, וכו'.
- rnnamespace
מחזיר דפים רק במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- rnfilterredir
איך לסנן הפניות.
- אחד מהערכים הבאים: all, redirects, nonredirects
- ברירת מחדל: nonredirects
- rnredirect
- מיושן.
נא להשתמש ב־rnfilterredir=redirects במקום.
- סוג: בוליאני (פרטים)
- rnlimit
להגביל את מספר הדפים האקראיים שיוחזרו.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 1
- rncontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- להחזיר שני דפים אקראיים מהמרחב הראשי.
- api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [פתיחה בארגז חול]
- החזרת מידע על הדף על שני דפים אקראיים מהמרחב הראשי.
- api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [פתיחה בארגז חול]
list=recentchanges (rc)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
למנות שינויים אחרונים.
- rcstart
מאיזה חותם־זמן להתחיל למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- rcend
באיזה חותם זמן להפסיק לרשום.
- סוג: חותם־זמן (תסדירים מורשים)
- rcdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: rcstart חייב להיות לפני rcend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: rcstart חייב להיות אחרי rcend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- rcnamespace
לסנן את השינויים רק למרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- rcuser
לרשום רק שינויים של המשתמש הזה.
- סוג: שם משתמש
- rcexcludeuser
Don't list changes by this user
- סוג: שם משתמש
- rctag
לרשום רק שינויים שמתויגים עם התג הזה.
- rcprop
לכלול פריטי מידע נוספים:
- user
- הוספת המשתמש האחראי על העריכה ותיוג אם זאת כתובת IP.
- userid
- הוספת המשתמש האחראי על העריכה.
- comment
- הוספת ההערה על העריכה.
- parsedcomment
- הוספת ההערה המפוענחת על העריכה.
- flags
- הוספת דגלים לעריכה.
- timestamp
- הוספת חותם־זמן של העריכה.
- title
- הוספת שם הדף של העריכה.
- ids
- הוספת מזהה הדף, מזהה שינויים אחרונים, והמזהה הגרסה החדשה והישנה.
- sizes
- הוספת אורך הדף החדש והישן בבייטים.
- redirect
- מתייג שהדף הוא הפניה.
- patrolled
- מתייג עריכה בת־בדיקה בתור בדוקה או בלתי־בדוקה.
- loginfo
- הוספת מידע יומן (זהה יומן, סוג יומן וכו') לעיולי יומן.
- tags
- רשימת תגים עבור העיול.
- sha1
- הוספת סיכום־ביקורת תוכן לעיולים שמשויכים לגרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): user, userid, comment, parsedcomment, flags, timestamp, title, ids, sizes, redirect, patrolled, loginfo, tags, sha1
- ברירת מחדל: title|timestamp|ids
- rctoken
- מיושן.
יש להשתמש ב־action=query&meta=tokens במקום.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): patrol
- rcshow
הצגה רק של פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק עריכות משניות שעשו משתמשים שנכנסו לחשבון, יש להגדיר rcshow=minor|!anon.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled, unpatrolled
- rclimit
כמה שינויים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- rctype
אילו סוגים של שינויים להציג.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): edit, new, log, external, categorize
- ברירת מחדל: edit|new|log|categorize
- rctoponly
לרשום רק שינויים שהם הגרסה האחרונה.
- סוג: בוליאני (פרטים)
- rccontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- rcgeneraterevisions
בעת שימוש בתור מחולל, לחולל מזהי גרסה במקום כותרות. עיולי שינויים אחרונים ללא מזהה גרסה משויך (למשל רוב עיולי היומן) לא יחוללו דבר.
- סוג: בוליאני (פרטים)
- הצגת השינויים האחרונים.
- api.php?action=query&list=recentchanges [פתיחה בארגז חול]
- קבלת מידע על הדף על שינויים אחרונים שלא נבדקו.
- api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info [פתיחה בארגז חול]
list=search (sr)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
ביצוע חיפוש בכל הטקסט.
- srsearch
חיפוש שמות דפים או תוכן שמתאים לערך הזה. אפשר להשתמש בחיפוש מחרוזת כדי לקרוא לאפשרויות חיפוש מתקדמות, בהתאם למה שממומש בשרת החיפוש של הוויקי.
- פרמטר זה נדרש.
- srnamespace
חיפוש רק במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ברירת מחדל: 0
- srlimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- sroffset
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- סוג: מספר שלם
- ברירת מחדל: 0
- srwhat
איזה סוג חיפוש לבצע.
- אחד מהערכים הבאים: title, text, nearmatch
- srinfo
אילו מטא־נתונים להחזיר.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): totalhits, suggestion, rewrittenquery
- ברירת מחדל: totalhits|suggestion|rewrittenquery
- srprop
אילו מאפיינים להחזיר:
- size
- הוספת גודל הדף בבייטים.
- wordcount
- הוספת מניין המילים של הדף.
- timestamp
- הוספת חותם־הזמן של העריכה האחרונה של הדף.
- snippet
- הוספת קטע קצר מפוענח מהדף.
- titlesnippet
- הוספת קטע קצר מפוענח משם הדף.
- redirecttitle
- הוספת שם ההפניה התואמת.
- redirectsnippet
- הוספת קטע קצר מפוענח משם ההפניה.
- sectiontitle
- הוספת שם הפסקה התואמת.
- sectionsnippet
- הוספת קטע קצר מפוענח של שם הפסקה התואמת.
- isfilematch
- הוספת בוליאני שמציין אם החיפוש תאם לתוכן של קובץ.
- categorysnippet
- הוספת קטע קצר מפוענח של הקטגוריה התואמת.
- score
- מיושן וחסר־השפעה.
- hasrelated
- מיושן וחסר־השפעה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): size, wordcount, timestamp, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, isfilematch, categorysnippet, score, hasrelated
- ברירת מחדל: size|wordcount|timestamp|snippet
- srinterwiki
לכלול תוצאות בינוויקי בחיפוש, אם זמין.
- סוג: בוליאני (פרטים)
- srenablerewrites
הפעלת שכתוב שאילתות פנימי. שרתי חיפוש אחדים יכולים לשכתב את השאילתה לצורה שלדעתם נותנת תוצאות טובות יותר, למשל תיקון שגיאות כתיב.
- סוג: בוליאני (פרטים)
- חיפוש meaning.
- api.php?action=query&list=search&srsearch=meaning [פתיחה בארגז חול]
- חיפוש טקסטים עבור meaning.
- api.php?action=query&list=search&srwhat=text&srsearch=meaning [פתיחה בארגז חול]
- קבלת מידע על הדף עבור שמוחזרים מחיפוש אחרי meaning.
- api.php?action=query&generator=search&gsrsearch=meaning&prop=info [פתיחה בארגז חול]
list=tags (tg)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
רשימת תגי שינוי.
- tgcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- tglimit
המספר המרבי של תגים לרשום.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- tgprop
אילו מאפיינים לקבל:
- name
- הוספת שם התג.
- displayname
- הוספת הודעת המערכת עבור התג.
- description
- הוספת תיאור התג.
- hitcount
- הוספת מספר הגרסאות ועיולי היומן עם התג הזה.
- defined
- ציון האם התג מוגדר.
- source
- קבלת מקורות התג, שיכולים להיות extension עבור תגים שמגדירות הרחבות ו־manual עבור תגים שמשתמשים יכולים להחיל ידנית.
- active
- האם התג עדיין מוּחל.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): name, displayname, description, hitcount, defined, source, active
- ברירת מחדל: name
list=usercontribs (uc)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת כל העריכות של המשתמש.
- uclimit
המספר המרבי של התרומות להחזיר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- ucstart
באיזה חותם־הזמן להתחיל.
- סוג: חותם־זמן (תסדירים מורשים)
- ucend
באיזה חותם־הזמן לסיים
- סוג: חותם־זמן (תסדירים מורשים)
- uccontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- ucuser
עבור אילו משתמשים לאחזר תרומות. לא יכול לשמש עם ucuserids או ucuserprefix.
- סוג: רשימת שמות משתמשים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ucuserids
מזהי המשתמשים לאחזור תרומות. לא יכול לשמש עם ucuser או ucuserprefix.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ucuserprefix
אחזור תרומות עבור כל המשתמשים שהשמות שלהם מתחילים בערך הזה. לא יכול לשמש עם ucuser או ucuserids.
- ucdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: ucstart חייב להיות לפני ucend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: ucstart חייב להיות אחרי ucend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- ucnamespace
לרשום רק תרומות במרחבי השם האלה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ucprop
לכלול פריטי מידע נוספים:
- ids
- הוספת מזהה הדף ומזהה הגרסה.
- title
- הוספת השם ומזהה מרחב השם של הדף.
- timestamp
- הוספת חותם־הזמן של העריכה.
- comment
- הוספת ההערה על העריכה.
- parsedcomment
- הוספת ההערה המפוענחת של העריכה.
- size
- הוספת הגודל החדש של העריכה.
- sizediff
- הוספת ההפרש של העריכה אל מול ההורה שלה.
- flags
- הוספת הדגלים של העריכה.
- patrolled
- מתייג עריכות בדוקות.
- tags
- רשימת תגים עבור עריכות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, timestamp, comment, parsedcomment, size, sizediff, flags, patrolled, tags
- ברירת מחדל: ids|title|timestamp|comment|size|flags
- ucshow
הצגה רק של פריטים שמתאימים לאמות המידה האלה, למשל רק עריכות לא־משניות.
אם מוגדר ucshow=patrolled או ucshow=!patrolled, גרסאות ישנות מ־$wgRCMaxAge (7776000 שניות) לא תוצגנה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): minor, !minor, patrolled, !patrolled, top, !top, new, !new
- uctag
לרשום רק גרסאות עם התג הזה.
- uctoponly
- מיושן.
לרשום רק שינויים שהם הגרסה האחרונה.
- סוג: בוליאני (פרטים)
- הצגת התרומות של המשתמש Example.
- api.php?action=query&list=usercontribs&ucuser=Example [פתיחה בארגז חול]
- הצגת תרומות מכל כתובות ה־IP שמתחילות ב־192.0.2..
- api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [פתיחה בארגז חול]
list=users (us)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע על רשימת משתמשים.
- usprop
אילו חלקי מידע לקבל:
- blockinfo
- מתייג אם המשתמש חסום, על־ידי מי, ומאיזו סיבה.
- groups
- רשימת כל הקבוצות שהמשתמש שייך אליהן.
- groupmemberships
- לרשום קבוצות שכל משתמש משויך אליהן במפורש, כולל תאריך תפוגה לחברות בכל קבוצה.
- implicitgroups
- רשימת כל הקבוצות שהמשתמש חבר בהן אוטומטית.
- rights
- רשימת כל ההרשאות שיש למשתמש.
- editcount
- הוספת מניין העריכות של המשתמש.
- registration
- הוספת חותם־הזמן של רישום המשתמש.
- emailable
- מתייג אם המשתמש יכול ורוצה לקבל דואר אלקטרוני דרך Special:Emailuser.
- gender
- מתייג את המגדר של המשתמש. מחזיר "male", "female" או "unknown".
- centralids
- הוספת המזהה המרכזי ומצב השיוך למשתמש.
- cancreate
- ציון האם אפשר ליצור חשבון עבור שמות משתמש תקינים, אבל לא רשומים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): blockinfo, groups, groupmemberships, implicitgroups, rights, editcount, registration, emailable, gender, centralids, cancreate
- usattachedwiki
עם usprop=centralids, לציין האם המשתמש משויך לוויקי עם המזהה הזה.
- ususers
רשימת משתמשים שעליהם צריך לקבל מידע.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ususerids
רשימת מזהי משתמש שעבורם יתקבל המידע.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ustoken
- מיושן.
יש להשתמש ב־action=query&meta=tokens במקום.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): userrights
- החזרת מידע עבור המשתמש Example.
- api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [פתיחה בארגז חול]
list=watchlist (wl)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת שינויים אחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
- wlallrev
לכלול גרסאות מרובות של אותו הדף בתוך מסגרת הזמן הנתונה.
- סוג: בוליאני (פרטים)
- wlstart
מאיזה חותם־זמן להתחיל למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- wlend
באיזה חותם זמן להפסיק לרשום.
- סוג: חותם־זמן (תסדירים מורשים)
- wlnamespace
סינון שינויים רק למרחבי השם שניתנו.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- wluser
לרשום רק שינויים של המשתמש הזה.
- סוג: שם משתמש
- wlexcludeuser
Don't list changes by this user
- סוג: שם משתמש
- wldir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: wlstart חייב להיות לפני wlend.
- older
- לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: wlstart חייב להיות אחרי wlend.
- אחד מהערכים הבאים: newer, older
- ברירת מחדל: older
- wllimit
כמה תוצאות סך הכול להחזיר בכל בקשה.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- wlprop
אילו מאפיינים נוספים לקבל:
- ids
- הוספת מזהי גסה ומזהי דף.
- title
- הוספת שם הדף.
- flags
- הוספת דגלים לעריכה.
- user
- הוספת המשתמש שעשה את העריכה.
- userid
- הוספת מזהה המשתמש של מי שעשה את העריכה.
- comment
- הוספת ההערה של העריכה.
- parsedcomment
- הוספת ההערכה המפוענחת של העריכה.
- timestamp
- הוספת חותם־זמן של העריכה.
- patrol
- תיוג עריכות שנבדקו.
- sizes
- הוספת האורך החדש והישן של הדף.
- notificationtimestamp
- הוספת חותם־זמן של ההודעה האחרונה למשתמש על העריכה.
- loginfo
- הוספת מידע מהיומן איפה שמתאים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp, loginfo
- ברירת מחדל: ids|title|flags
- wlshow
הצגה רק של פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק עריכות משניות שעשו משתמשים שנכנסו לחשבון, יש להגדיר wlshow=minor|!anon.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread
- wltype
אולי סוגי שינויים להציג:
- edit
- עריכות דף רגילות.
- new
- יצירות דף.
- log
- עיולי יומן.
- external
- שינויים חיצוניים.
- categorize
- שינויים בהשתייכות לקטגוריה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): edit, new, log, external, categorize
- ברירת מחדל: edit|new|log|categorize
- wlowner
משמש יחד עם wltoken לגישה לרשימת מעקב של משתמש אחר.
- סוג: שם משתמש
- wltoken
אסימון אבטחה (זמין ב־העדפות) שמאפשר לגשת לרשימת מעקב של משתמש אחר.
- wlcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- לרשום את הגרסה האחרונה עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&list=watchlist [פתיחה בארגז חול]
- אחזור מידע נוסף על הגרסה האחרונה עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [פתיחה בארגז חול]
- אחזור מידע על כל השינויים האחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [פתיחה בארגז חול]
- אחזור מידע על הדף עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&generator=watchlist&prop=info [פתיחה בארגז חול]
- אחזור מידע על הגרסה עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [פתיחה בארגז חול]
- לרשום את הגרסה האחרונה עבור דפים שהשתנו לאחרונה ברשימת המעקב של משתמש Example.
- api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [פתיחה בארגז חול]
list=watchlistraw (wr)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת כל הדפים ברשימת המעקב של המשתמש הנוכחי.
- wrcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- wrnamespace
לרשום רק דפים במרחב השם הנתון.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- wrlimit
כמה תוצאות סך הכול להחזיר בכל בקשה.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- wrprop
אילו מאפיינים נוספים לקבל:
- changed
- הוספת חותם־הזמן של ההודעה האחרונה למשתמש על העריכה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): changed
- wrshow
לרשום רק פריטים שעונים על אמות המידה האלו.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): changed, !changed
- wrowner
משמש יחד עם wrtoken לגישה לרשימת מעקב של משתמש אחר.
- סוג: שם משתמש
- wrtoken
אסימון אבטחה (זמין ב־העדפות) שמאפשר לגשת לרשימת מעקב של משתמש אחר.
- wrdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- wrfromtitle
מאיזו כותרת (עם תחילית מרחב שם) להתחיל למנות.
- wrtotitle
באיזו כותרת (עם תחילית מרחב שם) להפסיק למנות.
- לרשום דפים ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&list=watchlistraw [פתיחה בארגז חול]
- אחזור מידע על הדפים עבור דפים ברשימת המעקב של המשתמש הנוכחי.
- api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [פתיחה בארגז חול]
meta=allmessages (am)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת הודעות מהאתר הזה.
- ammessages
אילו הודעות לפלוט. כתיבת * (בררת מחדל) תפלוט את כל ההודעות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ברירת מחדל: *
- amprop
אלו מאפיינים לקבל.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): default
- amenableparser
יש להגדיר כדי להפעיל את המפענח, יעשה קדם־עיבוד לקוד ויקי של ההודעה (יחליף מילות קסם, יטפל בתבניות, וכו').
- סוג: בוליאני (פרטים)
- amnocontent
אם זה מוגדר, לא לכלול את תוכן ההודעות בפלט.
- סוג: בוליאני (פרטים)
- amincludelocal
לכלול גם הודעות מקומיות, כלומר הודעות שאינן קיימות בתכנה, אבל כן קיימות במרחב מדיה ויקי. זה רושם את כל הדפים במרחב מדיה ויקי, כך שזה ירשום גם דפים שאינם באמת הודעות, כגון Common.js.
- סוג: בוליאני (פרטים)
- amargs
ארגומנטים שיוחלפו לתוך ההודעה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- amfilter
החזרה רק של הודעות עם שמות שמכילים את המחרוזת הזאת.
- amcustomised
להחזיר רק הודעות במצב ההתאמה הזה.
- אחד מהערכים הבאים: all, modified, unmodified
- ברירת מחדל: all
- amlang
החזרת הודעת בשפה הזאת.
- amfrom
החזרת הודעת החל מההודעה הזאת.
- amto
החזרת הודעות עד ההודעה הזאת.
- amtitle
שם דף לשימוש בתור הֶקשר בעת ענוח הודעה (עבור האפשרות amenableparser).
- amprefix
החזרת הודעת עם התחילית הזאת.
- להציג הודעות שמתחילות ב־ipb-.
- api.php?action=query&meta=allmessages&refix=ipb- [פתיחה בארגז חול]
- להציג את ההודעות august ו־mainpage בגרמנית.
- api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de [פתיחה בארגז חול]
meta=authmanagerinfo (ami)
- מקור: MediaWiki
- רישיון: GPL-2.0+
אחזור מידע אודות מצב האימות הנוכחי.
- amisecuritysensitiveoperation
בדיקה האם מצב האימות הנוכחי של המשתמש מספיק בשביל הפעולה הרגישה מבחינת אבטחה שצוינה.
- amirequestsfor
אחזור מידע על בקשות האימות הדרושות לפעולת האימות המבוקשת.
- אחד מהערכים הבאים: login, login-continue, create, create-continue, link, link-continue, change, remove, unlink
- amimergerequestfields
מיזוג מידע של שדות עבור כל בקשות האימות למערך אחד.
- סוג: בוליאני (פרטים)
- amimessageformat
תסדיר לשימוש בהחזרת הודעות.
- אחד מהערכים הבאים: html, wikitext, raw, none
- ברירת מחדל: wikitext
- אחזור הבקשות שיכולות לשמש לתחילת הכניסה.
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [פתיחה בארגז חול]
- אחזור הבקשות שיכולות לשמש לתחילת הכניסה, עם שדות טופס ממוזגים.
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [פתיחה בארגז חול]
- בדיקה האם האימות מספיק בשביל הפעולה foo.
- api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [פתיחה בארגז חול]
meta=filerepoinfo (fri)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת מידע מטא על מאגרי תמונות שמוגדרים בוויקי.
- friprop
אילו מאפייני מאגר לקבל (יכולים להיות יותר מזה באתרי ויקי אחדים):
- apiurl
- URL ל־API של המאגר – מועיל לקבלת מידע על התמונה מהמארח.
- name
- המפתח של המאגר – משמש למשל בערכים המוחזרים מ־$wgForeignFileRepos ומ־imageinfo.
- displayname
- שם קריא של אתר הוויקי של המאגר.
- rooturl
- URL שורש לנתיבי תמונות.
- local
- האם המאגר הוא מקומי או לא.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, scriptDirUrl, scriptExtension, favicon, canUpload
- ברירת מחדל: name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload
- קבלת מידע על מאגרי קבצים.
- api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname [פתיחה בארגז חול]
meta=siteinfo (si)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
החזרת מידע כללי על האתר.
- siprop
איזה מיד לקבל:
- general
- מידע מערכת כללי.
- namespaces
- רשימת מרחבי שם רשומים והשמות הקנוניים שלהם.
- namespacealiases
- רשימת כינויי מרחבי שם רשומים.
- specialpagealiases
- רשימת כינויים דפים מיוחדים.
- magicwords
- רשימות מילות קסם וכינוייהן.
- interwikimap
- החזרת מפת בינוויקי (אפשר שתהיה מסוננת, אפשר שתהיה מותאמת מקומית באמצעות siinlanguagecode).
- dbrepllag
- החזרת שרת מסד־נתונים עם שיהוי השכפול הגבוה ביותר.
- statistics
- החזרזת סטטיסטיקות אתר.
- usergroups
- החזרת קבוצות משתמשים וההרשאות המשויכות.
- libraries
- החזרת הספריות המותקנות בוויקי.
- extensions
- החזרת ההרחבות המותקנות בוויקי.
- fileextensions
- החזרת רשימת סיומות קבצים (סוגי קבצים) שאפשר להעלות.
- rightsinfo
- החזרת הזכויות (הרישיון) של הוויקי, אם זמין.
- restrictions
- החזרת מידע על ההגבלות (ההגנות) הזמינות.
- languages
- החזרת השפות שמדיה־ויקי תומכת בהן (זה יכול להיות מותאם מקומים עם siinlanguagecode).
- languagevariants
- מחזיר רשימת קודי שפה שמופעל עבורם ממיר שפה (LanguageConverter), וההגוונים הנתמכים עבור כל אחת מהן.
- skins
- החזרת רשימת כל העיצובים הזמינים (זה יכול להיות מותאם מקומית באמצעות siinlanguagecode, אחרת זה יהיה בשפת התוכן).
- extensiontags
- החזרת רשימת תגי הרחבת מפענח.
- functionhooks
- החזרת hook־ים של הרחבות מפענח.
- showhooks
- החזרת כל ה־hook־ים המנויים (תוכן של $wgHooks).
- variables
- החזרת מזהי משתנים.
- protocols
- החזרת רשימת הפרוטוקולים המותרים בקישורים חיצוניים.
- defaultoptions
- החזרת הערכים ההתחלתיים של העדפות משתמש.
- uploaddialog
- החזרת הגדרות תיבת ההעלאה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, libraries, extensions, fileextensions, rightsinfo, restrictions, languages, languagevariants, skins, extensiontags, functionhooks, showhooks, variables, protocols, defaultoptions, uploaddialog
- ברירת מחדל: general
- sifilteriw
החזרה רק של עיולים מקומיים או רק של עיולים לא מקומיים ממפת הבינוויקי.
- אחד מהערכים הבאים: local, !local
- sishowalldb
רשימת כל שרתי מסד הנתונים, לא רק אלה שהכי מתעכבים.
- סוג: בוליאני (פרטים)
- sinumberingroup
רשימת מספרי משתמשים בקבוצות משתמשים.
- סוג: בוליאני (פרטים)
- siinlanguagecode
קוד שפה ששמות שפות מתורגמות (מאמץ טוב ביותר) ושמות עיצובים.
- איזור מידע על האתר.
- api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics [פתיחה בארגז חול]
- אחזור תחיליות בינוויקי מקומיות.
- api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local [פתיחה בארגז חול]
- בדיקת שיהוי השכפול הנוכחי.
- api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb= [פתיחה בארגז חול]
meta=tokens
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת אסימונים לפעולות שמשנות נתונים.
- type
סוגי האסימונים לבקש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): createaccount, csrf, login, patrol, rollback, userrights, watch
- ברירת מחדל: csrf
- אחזור אסימון csrf (בררת המחדל).
- api.php?action=query&meta=tokens [פתיחה בארגז חול]
- אחזור אסימון של רשימת המעקב ואסימון של ניטור
- api.php?action=query&meta=tokens&type=watch|patrol [פתיחה בארגז חול]
meta=userinfo (ui)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע על המשתמש הנוכחי.
- uiprop
אילו חלקי מידע לכלול:
- blockinfo
- מתייג אם המשתמש הנוכחי נחסם, על־ידי מי ומאיזו סיבה.
- hasmsg
- הוספת התג messages אם למשתמש הנוכחי יש הודעות ממתינות.
- groups
- רשימת כל הקבוצות שהמשתמש שייך אליהן.
- groupmemberships
- לרשום קבוצות שהמשתמש הנוכחי משויך אליהן במפורש, כולל תאריך תפוגה לחברות בכל קבוצה.
- implicitgroups
- רשימת כל הקבוצות שהמשתמש שייך אליהן באופן אוטומטי.
- rights
- רשימת כל ההרשאות שיש למשתמש הזה.
- changeablegroups
- רשימת הקבוצות שהמשתמש הנוכחי יכול להוסיף אליהן ולגרוע מהן.
- options
- רשימת כל ההעדפות שהמשתמש הנוכחי הגדיר.
- preferencestoken
- מיושן. קבלת אסימון לשינוי ההעדפות של המשתמש הנוכחי.
- editcount
- הוספת מניין העריכות של המשתמש הנוכחי.
- ratelimits
- רשימת כל מגבלות הקצב שחלות על המשתמש הנוכחי.
- הוספת כתובת הדוא"ל ותאריך אימות כתובת הדוא"ל.
- realname
- הוספת השם האמתי של המשתמש.
- acceptlang
- מדפיס את כותרת
Accept-Languageששלח הלקוח בתסדיר מובנה. - registrationdate
- הוספת תאריך הרישום של המשתמש.
- unreadcount
- הוספת מניין הדפים שלא נקראו ברשימת המעקב של המשתמש (לכל היותר 999; מחזיר 1000+ אם יש יותר).
- centralids
- הוספת המזהה המרכזי ומצב השיוך למשתמש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): blockinfo, hasmsg, groups, groupmemberships, implicitgroups, rights, changeablegroups, options, preferencestoken, editcount, ratelimits, email, realname, acceptlang, registrationdate, unreadcount, centralids
- uiattachedwiki
עם uiprop=centralids, לציין האם המשתמש משויך לוויקי עם המזהה הזה.
- קבלת מידע על המשתמש הנוכחי.
- api.php?action=query&meta=userinfo [פתיחה בארגז חול]
- קבלת מידע נוסף על המשתמש הנוכחי.
- api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg [פתיחה בארגז חול]
action=removeauthenticationdata
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
הסרת נתוני אימות עבור המשתמש הנוכחי.
- request
להשתמש בבקשת האימות הזאת, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=remove.
- פרמטר זה נדרש.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לנסות להסיר את נתוני המשתמש הנוכחי בשביל FooAuthenticationRequest.
- api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [פתיחה בארגז חול]
action=resetpassword
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שליחת דוא"ל איפוס סיסמה למשתמש.
- user
המשתמש שמאופס.
- סוג: שם משתמש
כתובת הדוא"ל של המשתמש שהסיסמה שלו מאופסת.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- שליחת מכתב איפוס ססמה למשתמש Example.
- api.php?action=resetpassword&user=Example&token=123ABC [פתיחה בארגז חול]
- שליחת מכתב איפוס ססמה לכל המשתמשים שהכתובת שלהם היא user@example.com.
- api.php?action=resetpassword&user=user@example.com&token=123ABC [פתיחה בארגז חול]
action=revisiondelete
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
מחיקה ושחזור ממחיקה של גרסאות.
- type
סוג מחיקת הגרסה שמתבצע.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: revision, archive, oldimage, filearchive, logging
- target
שם הדף למחיקת גרסה, אם זה נחוץ לסוג.
- ids
מזהים של הגרסה שתימחק.
- פרמטר זה נדרש.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- hide
מה להסתיר עבור כל גרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): content, comment, user
- show
הסתרה של מה לבטל עבור כל גרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): content, comment, user
- suppress
האם להעלים נתונים ממפעילים ומאחרים.
- אחד מהערכים הבאים: yes, no, nochange
- ברירת מחדל: nochange
- reason
סיבה למחיקה או לשחזור ממחיקה.
- tags
אילו תגים להחיל על העיול ביומן המחיקה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- הסתרת התוכן של הגרסה 12345 בדף Main Page.
- api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&hide=content&token=123ABC [פתיחה בארגז חול]
- הסתרת כל הנתונים על רשומת היומן 67890 עם הסיבה BLP violation.
- api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&reason=BLP%20violation&token=123ABC [פתיחה בארגז חול]
action=rollback
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
ביטול העריכה האחרונה לדף.
אם המשמש האחרון שערך את הדף עשה מספר עריכות זו אחר זו, הן תשוחזרנה.
- title
שם הדף לשחזור. לא יכול לשמש יחד עם pageid.
- pageid
מזהה הדף לשחזור. לא יכול לשמש יחד עם title.
- סוג: מספר שלם
- tags
אילו תגים להחיל על השחזור.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- user
שם המשתמשים שהעריכות שלו תשוחזרנה.
- פרמטר זה נדרש.
- סוג: שם משתמש
- summary
תקציר עריכה מותאם. אם ריק, ישמש תקציר לפי בררת מחדל.
- ברירת מחדל: (ריק)
- markbot
לסמן את העריכות ששוחזרו ואת השחזור בתור עריכות בוט.
- סוג: בוליאני (פרטים)
- watchlist
הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.
- אחד מהערכים הבאים: watch, unwatch, preferences, nochange
- ברירת מחדל: preferences
- token
אסימון "rollback" שאוחזר מ־action=query&meta=tokens
לשם תאימות, גם האסימון שמשמש בממשק דפדפן מתקבל.
- פרמטר זה נדרש.
- שחזור העריכות האחרונות לדף Main Page על־ידי המשתמש Example.
- api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [פתיחה בארגז חול]
- שחזור העריכות האחרונות לדף Main Page מאת משתמש ה־IP 192.0.2.5 עם התקציר Reverting vandalism וסימון של העריכות האלה ושל השחזור בתור עריכות בוט.
- api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [פתיחה בארגז חול]
action=rsd
- מקור: MediaWiki
- רישיון: GPL-2.0+
יצוא סכמת RSD (Really Simple Discovery).
- יצוא סכמת ה־RSD.
- api.php?action=rsd [פתיחה בארגז חול]
action=setnotificationtimestamp
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
עדכון חותם־הזמן של ההודעה עבור דפים במעקב.
זה משפיע על הדגשת הדפים שהשתנו ברשימת המעקב ובהיסטוריה, ושליחת דואר אלקטרוני כאשר ההעדפה "לשלוח אליי דוא"ל כאשר משתנה דף או קובץ ברשימת המעקב שלי" מופעלת.
- entirewatchlist
לעבוד על כל הדפים שבמעקב.
- סוג: בוליאני (פרטים)
- timestamp
חותם־הזמן להגדרת חותם־זמן של הודעה.
- סוג: חותם־זמן (תסדירים מורשים)
- torevid
לאיזו גרסה להגדיר את חותם הזמן (רק דף אחד).
- סוג: מספר שלם
- newerthanrevid
הגרסה שחותם־הזמן של ההודעה יוגדר בתור חדש ממנה (רק דף אחד).
- סוג: מספר שלם
- continue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- titles
רשימת כותרות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pageids
רשימת מזהי דף לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- revids
רשימת מזהי גרסה לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- generator
קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.
לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz וגם zh.
- סוג: בוליאני (פרטים)
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- אתחול מצב ההודעה עבור כל רשימת המעקב.
- api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [פתיחה בארגז חול]
- אתחול מצב ההודעה עבור Main Page.
- api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC [פתיחה בארגז חול]
- הגדרת חותם־הזמן להודעה ל־Main page כך שכל העריכות מאז 1 בינואר 2012 מוגדרות בתור כאלה שלא נצפו.
- api.php?action=setnotificationtimestamp&titles=Main_page×tamp=2012-01-01T00:00:00Z&token=123ABC [פתיחה בארגז חול]
- אתחול מצב ההודעה עבור דפים במרחב השם משתמש.
- api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC [פתיחה בארגז חול]
action=setpagelanguage
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שינוי השפה של דף לא מורשה בוויקי זה.
הפעל את $wgPageLanguageUseDB על מנת להשתמש בפעולה זו
- title
כותרת הדף שאת שפתו ברצונך לשנות. לא אפשרי להשתמש באפשרות עם pageid.
- pageid
מזהה הדף שאת שפתו ברצונך לשנות. לא אפשרי להשתמש באפשרות עם title.
- סוג: מספר שלם
- lang
קוד השפה של השפה שאליה צריך לשנות את הדף. יש להשתמש ב־default כדי לאתחל את הדף לשפת בררת המחדל של הוויקי.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: default, ab, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, ak, aln, am, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, ban, bar, bbc, bbc-latn, bcc, bcl, be, be-tarask, bg, bgn, bh, bho, bi, bjn, bm, bn, bo, bpy, bqi, br, brh, bs, bto, bug, bxr, ca, cbk-zam, cdo, ce, ceb, ch, chr, chy, ckb, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, de, de-at, de-ch, de-formal, din, diq, dsb, dtp, dty, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, eo, es, et, eu, ext, fa, ff, fi, fit, fj, fo, fr, frc, frp, frr, fur, fy, ga, gag, gan, gan-hans, gan-hant, gd, gl, glk, gn, gom, gom-deva, gom-latn, gor, got, grc, gsw, gu, gv, ha, hak, haw, he, hi, hif, hif-latn, hil, hr, hrx, hsb, ht, hu, hy, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kg, khw, ki, kiu, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, krc, kri, krj, krl, ks, ks-arab, ks-deva, ksh, ku, ku-arab, ku-latn, kv, kw, ky, la, lad, lb, lbe, lez, lfn, lg, li, lij, liv, lki, lmo, ln, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mai, map-bms, mdf, mg, mhr, mi, min, mk, ml, mn, mo, mr, mrj, ms, mt, mwl, my, myv, mzn, na, nah, nan, nap, nb, nds, nds-nl, ne, new, niu, nl, nl-informal, nn, nov, nrm, nso, nv, ny, oc, olo, om, or, os, pa, pag, pam, pap, pcd, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, qu, qug, rgn, rif, rm, rmy, ro, roa-tara, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, sei, ses, sg, sgs, sh, shi, shn, si, sk, sl, sli, sm, sma, sn, so, sq, sr, sr-ec, sr-el, srn, ss, st, stq, su, sv, sw, szl, ta, tcy, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tn, to, tokipona, tpi, tr, tru, ts, tt, tt-cyrl, tt-latn, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, ve, vec, vep, vi, vls, vmf, vo, vot, vro, wa, war, wo, wuu, xal, xh, xmf, yi, yo, yue, za, zea, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu
- reason
הסיבה לשינוי.
- tags
אילו תגי שינוי להחיל על העיול ביומן שמתבצע כתוצאה מהפעולה הזאת.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- שינוי השפה של Main Page לבסקית.
- api.php?action=setpagelanguage&title=Main%20Page&lang=eu&token=123ABC [פתיחה בארגז חול]
- שינוי השפה של הדף בעל המזהה 123 לשפה הרגילה של הוויקי.
- api.php?action=setpagelanguage&pageid=123&lang=default&token=123ABC [פתיחה בארגז חול]
action=stashedit
- היחידה הזאת היא פנימית או בלתי־יציבה. הפעולה שלה יכולה להשתנות ללא הודעה מוקדמת.
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
הכנת עריכה במטמון משותף.
זה מיועד לשימוש דרך AJAX מתוך ערך כדי לשפר את הביצועים של שמירת הדף.
- title
כותרת הדף הנערך.
- פרמטר זה נדרש.
- section
מספר הפסקה. 0 עבור הפסקה הראשונה, new עבור פסקה חדשה.
- sectiontitle
כותרת הפסקה החדשה.
- text
תוכן הדף.
- stashedtexthash
גיבוב של תוכן דף מסליק קודם שישמש במקום זה.
- summary
לשנות תקציר.
- contentmodel
מודל התוכן של התוכן החדש.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: wikitext, javascript, json, css, text
- contentformat
תסדיר הסדרת תוכן עבור טקסט הקלט.
- פרמטר זה נדרש.
- אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
- baserevid
מזהה גסה של גרסת הבסיס.
- פרמטר זה נדרש.
- סוג: מספר שלם
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
action=tag
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
הוספת או הסרה של תגים מגרסאות בודדות או עיולי יומן בודדים.
- rcid
מזהה שינוי אחרון אחד או יותר שתג יתווסף אליו או יוסר ממנו.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- revid
מזהה גרסה אחד או יותר שתג יתווסף אליה או יוסר ממנה.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- logid
מזהה רשומת יומן אחת או יותר שתג יתווסף אליה או יוסר ממנה.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- add
התגים להוספה. אפשר להוסיף רק תגים קיימים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- remove
תגים להסרה. רק תגים שהוגדרו ידנית או שאינם מוגדרים כלל יכולים להיות מוסרים.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- reason
סיבה לשינוי.
- ברירת מחדל: (ריק)
- tags
אילו תגים להחיל על רשומת היומן שתיווצר כתוצאה מהפעולה הזאת.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- הוספת התג vandalism לגרסה עם המזהה 123 בלי לציין סיבה
- api.php?action=tag&revid=123&add=vandalism&token=123ABC [פתיחה בארגז חול]
- הסרת התג spam מעיול עם המזהה 123 עם הסיבה Wrongly applied
- api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [פתיחה בארגז חול]
action=tokens
- יחידה זו אינה מומלצת לשימוש.
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת אסימונים לפעולות שמשנות נתונים.
היחידה הזאת הוכרזה בתור מיושנת לטובת action=query&meta=tokens.
- type
סוגי האסימונים לבקש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): block, createaccount, csrf, delete, edit, email, import, login, move, options, patrol, protect, rollback, unblock, userrights, watch
- ברירת מחדל: edit
- אחזור אסימון עריכה (בררת המחדל).
- api.php?action=tokens [פתיחה בארגז חול]
- אחזור אסימון דוא"ל ואסימון העברה.
- api.php?action=tokens&type=email|move [פתיחה בארגז חול]
action=unblock
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שחרור משתמש מחסימה.
- id
מזהה החסימה לשחרור (מתקבל דרך list=blocks). לא יכול לשמש יחד עם user או userid.
- סוג: מספר שלם
- user
שם משתמש, כתובת IP או טווח כתובות IP לחסימה. לא יכול לשמש יחד עם id או userid.
- userid
מזהה המשתמש שישוחרר מחסימה. לא יכול לשמש יחד עם id או user.
- סוג: מספר שלם
- reason
סיבה להסרת חסימה.
- ברירת מחדל: (ריק)
- tags
תגי שינוי שיחולו על העיול ביומן החסימה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לשחרר את החסימה עם מזהה #105.
- api.php?action=unblock&id=105 [פתיחה בארגז חול]
- לשחרר את החסימה של המשתמש Bob עם הסיבה Sorry Bob.
- api.php?action=unblock&user=Bob&reason=Sorry%20Bob [פתיחה בארגז חול]
action=undelete
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שחזור גרסאות של דף מחוק.
אפשר לאחזר רשימת גרסאות מחוקות (כולל חותמי־זמן) דרך prop=deletedrevisions, ואפשר לאחזר רשימת מזהי קבצים מחוקים דרך list=filearchive.
- title
שם הדף לשחזור ממחיקה.
- פרמטר זה נדרש.
- reason
סיבה לשחזור.
- ברירת מחדל: (ריק)
- tags
תגי שינוי שיחולו על העיול ביומן המחיקה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- timestamps
חותמי־זמן של הגרסה לשחזור. אם גם timestamps וגם fileids ריקים, הכול ישוחזר.
- סוג: רשימת חותמי־זמן (תסדירים מורשים)
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- fileids
מזהי גרסאות הקובץ לשחזור. אם גם timestamps וגם fileids ריקים, הכול ישוחזר.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- watchlist
הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.
- אחד מהערכים הבאים: watch, unwatch, preferences, nochange
- ברירת מחדל: preferences
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- שחזור ממחיקה של הדף Main Page.
- api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page [פתיחה בארגז חול]
- שחזור שתי גרסאות של הדף Main Page.
- api.php?action=undelete&title=Main%20Page&token=123ABC×tamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z [פתיחה בארגז חול]
action=unlinkaccount
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
ביטול קישור של חשבון צד־שלישי מהמשתמש הנוכחי.
- request
להשתמש בבקשת האימות הזאת, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=unlink.
- פרמטר זה נדרש.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לנסות להסיר את הקישור של המשתמש הנוכחי לספק המשויך עם FooAuthenticationRequest.
- api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [פתיחה בארגז חול]
action=upload
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
העלאת קובץ, או קבלת מצב ההעלאות הממתינות.
יש מספר שיטות:
- להעלות את הקובץ ישירות, באמצעות הפרמטר file.
- להעלות את הקובץ בחלקים, באמצעות הפרמטרים filesize, chunk ו־offset.
- לגרום לשרת מדיה־ויקי לאחזר את הקובץ מ־URL באמצעות הפרמטר url.
- להשלים העלאה קודמת שנכשלה בשל אזהרות באמצעות הפרמטר filekey.
לתשומך לבך, יש לעשות את HTTP POST בתור העלאת קובץ (כלומר באמצעות multipart/form-data) בעת שליחת ה־file.
- filename
שם קובץ היעד.
- comment
הערת העלאה. משמש גם בתור טקסט הדף ההתחלתי עבור קבצים חדשים אם text אינו מצוין.
- ברירת מחדל: (ריק)
- tags
שינוי תגים להחלה לרשומות ההעלאה ולגרסאות דף הקובץ.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- text
טקסט הדף ההתחלתי לקבצים חדשים.
- watch
- מיושן.
לעקוב אחרי הדף.
- סוג: בוליאני (פרטים)
- watchlist
הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.
- אחד מהערכים הבאים: watch, preferences, nochange
- ברירת מחדל: preferences
- ignorewarnings
להתעלם מכל האזהרות.
- סוג: בוליאני (פרטים)
- file
תוכן הקובץ.
- חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
- url
URL לאחזור הקובץ.
- filekey
מפתח שמזהה העלאה קודמת שהוסלקה באופן זמני.
- sessionkey
- מיושן.
אותו דבר כמו filekey, מושאר לצור תאימות אחורה.
- stash
אם זה מוגדר, השרת יסליק זמנית את הקובץ במקום להוסיף אותו למאגר.
- סוג: בוליאני (פרטים)
- filesize
גודל הקובץ של כל ההעלאה.
- הערך חייב להיות בין 0 ל־104,857,600.
- סוג: מספר שלם
- offset
היסט הפלח בבתים.
- הערך לא יכולים להיות קטנים מ־0.
- סוג: מספר שלם
- chunk
תוכן החתיכה.
- חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
- async
להפוך פעולות קבצים גדולות לאסינכרוניות כשאפשר.
- סוג: בוליאני (פרטים)
- checkstatus
לאחזר רק מצב העלאה עבור מפתח הקובץ שניתן.
- סוג: בוליאני (פרטים)
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC){kind=link}
![[פתיחה בארגז חול]](/index.php?title=%D7%9E%D7%99%D7%95%D7%97%D7%93:ApiSandbox#action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC){kind=link}
action=userrights
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
שינוי חברות בקבוצות של המשתמש.
- user
שם משתמש.
- סוג: שם משתמש
- userid
מזהה משתמש.
- סוג: מספר שלם
- add
הוספת המשתמש לקבוצות האלו, ואם הוא כבר חבר, עדכון זמן התפוגה של החברות בקבוצה הזאת.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): bot, sysop, bureaucrat
- expiry
חותמי־זמן תפוגה. יכולים להיות יחסיים (למשל 5 months או 2 weeks) או מוחלטים (למשל 2014-09-18T12:34:56Z). אם מוגדר רק חותם־זמן אחד, הוא ישמש לכל הקבוצות שהועברו לפרמטר add. יש להשתמש ב־infinite, indefinite, infinity, או never בשביל קבוצת משתמשים שאינה פגה לעולם.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- ברירת מחדל: infinite
- remove
הסרת משתמש מהקבוצות האלו.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): bot, sysop, bureaucrat
- reason
סיבה לשינוי.
- ברירת מחדל: (ריק)
- token
אסימון "userrights" שאוחזר מ־action=query&meta=tokens
לשם תאימות, גם האסימון שמשמש בממשק דפדפן מתקבל.
- פרמטר זה נדרש.
- tags
לשנות את התגים שיוחלו על העיול ביומן הרשאות המשתמש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- הוספת המשתמש FooBot לקבוצה bot והסרתו מהקבוצות sysop ו־bureaucrat.
- api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [פתיחה בארגז חול]
- הוספת המשתמש עם המזהה 123 לקבוצה bot והסרתו מהקבוצות sysop ו־bureaucrat.
- api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [פתיחה בארגז חול]
- להוסיף את SometimeSysop לקבוצה sysop לחודש אחד.
- api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [פתיחה בארגז חול]
action=validatepassword
- יחידה זו דורשת הרשאות קריאה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לבדוק תקינות ססמה אל מול מדיניות הססמאות של הוויקי.
התקינות מדווחת כ־Good אם הססמה קבילה, Change אם הססמה יכולה לשמש לכניסה, אבל צריכה להשתנות, או Invalid אם הססמה אינה שמישה.
- password
ססמה שתקינותה תיבדק.
- פרמטר זה נדרש.
- user
שם משתמש, לשימוש בעת בדיקת יצירת חשבון. המשתמש ששמו ניתן צריך לא להיות קיים.
- סוג: שם משתמש
כתובת הדוא"ל, לשימוש בעת בדיקת יצירת חשבון.
- realname
שם אמתי, לשימוש בעת בדיקת יצירת חשבון.
- לבדוק את תקינות הססמה foobar עבור המשתמש הנוכחי.
- api.php?action=validatepassword&password=foobar [פתיחה בארגז חול]
- לבדוק את תקינות הססמה qwerty ליצירת החשבון Example.
- api.php?action=validatepassword&password=querty&user=Example [פתיחה בארגז חול]
action=watch
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0+
להוסיף דפים לרשימת המעקב של המשתמש הנוכחי או הסרתם ממנה.
- title
- מיושן.
הדף להוסיף לרשימת המעקב או להסיר ממנה. יש להשתמש במקום זאת ב־titles.
- unwatch
אם זה מוגדר, הדף יהיה לא במעקב במקום להיות במעקב.
- סוג: בוליאני (פרטים)
- continue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- titles
רשימת כותרות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- pageids
רשימת מזהי דף לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- revids
רשימת מזהי גרסה לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי. מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- generator
קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.
לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz וגם zh.
- סוג: בוליאני (פרטים)
- token
אסימון "watch" שאוחזר מ־action=query&meta=tokens
- פרמטר זה נדרש.
- לעקוב אחרי הדף Main Page.
- api.php?action=watch&titles=Main_Page&token=123ABC [פתיחה בארגז חול]
- להפסיק את המעקב אחרי הדף Main Page.
- api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC [פתיחה בארגז חול]
- לעקוב אחרי הדפים הראשונים במרחב הראשי.
- api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC [פתיחה בארגז חול]
format=json
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט נתונים בתסדיר JSON.
- callback
אם זה צוין, עוטף את הפלט לתוך קריאת פונקציה נתונה. למען הבטיחות, כל הנתונים הייחודיים למשתמש יוגבלו.
- utf8
אם זה צוין, רוב התווים שאינם ASCII (אבל לא כולם) יקודדו בתור UTF-8 במקום להתחלף בסדרות חילוף הקסדצימליות. זאת בררת המחדל אם הערך של formatversion הוא לא 1.
- סוג: בוליאני (פרטים)
- ascii
אם זה צוין, לקודד את כל מה שאינו ASCII בסדרות חילוף הקסדצימליות. זאת בררת המחדל כש־formatversion היא 1.
- סוג: בוליאני (פרטים)
- formatversion
תסדיר הפלט:
- 1
- תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
- 2
- תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
- latest
- להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
- אחד מהערכים הבאים: 1, 2, latest
- ברירת מחדל: 1
- להחזיר את תוצאות השאילתה בתסדיר JSON.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=json [פתיחה בארגז חול]
format=jsonfm
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט נתונים בתסדיר JSON (עם הדפסה יפה ב־HTML).
- wrappedhtml
החזרת HTML מעוצב ומודולי ResourceLoader משויכים בתור עצם JSON.
- סוג: בוליאני (פרטים)
- callback
אם זה צוין, עוטף את הפלט לתוך קריאת פונקציה נתונה. למען הבטיחות, כל הנתונים הייחודיים למשתמש יוגבלו.
- utf8
אם זה צוין, רוב התווים שאינם ASCII (אבל לא כולם) יקודדו בתור UTF-8 במקום להתחלף בסדרות חילוף הקסדצימליות. זאת בררת המחדל אם הערך של formatversion הוא לא 1.
- סוג: בוליאני (פרטים)
- ascii
אם זה צוין, לקודד את כל מה שאינו ASCII בסדרות חילוף הקסדצימליות. זאת בררת המחדל כש־formatversion היא 1.
- סוג: בוליאני (פרטים)
- formatversion
תסדיר הפלט:
- 1
- תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
- 2
- תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
- latest
- להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
- אחד מהערכים הבאים: 1, 2, latest
- ברירת מחדל: 1
- להחזיר את תוצאות השאילתה בתסדיר JSON.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm [פתיחה בארגז חול]
format=none
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לא לפלוט שום דבר.
- להחזיר את תוצאות השאילתה בתסדיר NONE.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=none [פתיחה בארגז חול]
format=php
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט נתונים בתסדיר PHP מוסדר.
- formatversion
תסדיר הפלט:
- 1
- תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
- 2
- תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
- latest
- להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
- אחד מהערכים הבאים: 1, 2, latest
- ברירת מחדל: 1
- להחזיר את תוצאות השאילתה בתסדיר PHP.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=php [פתיחה בארגז חול]
format=phpfm
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט נתונים בתסדיר PHP מוסדר (עם הדפסה יפה ב־HTML).
- wrappedhtml
החזרת HTML מעוצב ומודולי ResourceLoader משויכים בתור עצם JSON.
- סוג: בוליאני (פרטים)
- formatversion
תסדיר הפלט:
- 1
- תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
- 2
- תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
- latest
- להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
- אחד מהערכים הבאים: 1, 2, latest
- ברירת מחדל: 1
- להחזיר את תוצאות השאילתה בתסדיר PHP.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm [פתיחה בארגז חול]
format=rawfm
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט את הנתונים, כולל אלמנטים לניפוי שגיאות, בתסדיר JSON (עם הדפסה יפה ב־HTML).
- wrappedhtml
החזרת HTML מעוצב ומודולי ResourceLoader משויכים בתור עצם JSON.
- סוג: בוליאני (פרטים)
- להחזיר את תוצאות השאילתה בתסדיר RAW.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm [פתיחה בארגז חול]
format=xml
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט נתונים בתסדיר XML.
- xslt
אם צוין, יש להוסיף את שם הדף כגיליון עיצוב XSL. על הערך להיות כותרת ב מדיה ויקי במרחב שם המשתמש, המסתיים ב-
.xsl.- includexmlnamespace
אם זה צוין, מוסיף מרחב שם של XML.
- סוג: בוליאני (פרטים)
- להחזיר את תוצאות השאילתה בתסדיר XML.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml [פתיחה בארגז חול]
format=xmlfm
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
לפלוט נתונים בתסדיר XML (עם הדפסה יפה ב־HTML).
- להחזיר את תוצאות השאילתה בתסדיר XML.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm [פתיחה בארגז חול]
סוגי נתונים
קלט למדיה־ויקי צריך להיות בקידוד UTF-8 מנורמל ב־NFC. מדיה־ויקי יכולה לנסות להמיר קלט אחר, אבל זה עלול לגרום לפעולות מסוימות (כגון עריכות עם בדיקות MD5) להיכשל.
חלק מסוגי הפרמטרים בבקשות API דורשים הסבר נוסף:
- בוליאני (boolean)
- פרמטרים בוליאניים עובדים כמו תיבות סימון של HTML: אם הפרמטר צוין, בלי קשר לערך שלו, הוא אמת (true). בשביל ערך שקר (false), יש להשמיט את הפרמטר לגמרי.
- חותם־זמן (timestamp)
- אפשר לכתוב חותמי־זמן במספר תסדירים. תאריך ושעה לפי ISO 8601 הוא הדבר המומלת. כל הזמנים מצוינים ב־ UTC, לא תהיה השפעה לשום אזור זמן שיצוין.
- תאריך ושעה לפי ISO 8601, 2001-01-15T14:56:00Z (לא חובה לכתוב פיסוק ו־Z)
- תאריך ושעה לפי ISO 8601 עם חלקי שנייה (שלא תהיה להם שום השפעה), 2001-01-15T14:56:00.00001Z (לא חובה לכתוב קווים מפרידים, נקודתיים ו־Z)
- תסדיר MediaWiki, 20010115145600
- תסדיר מספרי כללי, 2001-01-15 14:56:00 (לאזור זמן אופציונלי של GMT, +##, או -## אין השפעה)
- תסדיר EXIF, 2001:01:15 14:56:00
- תסדיר RFC 2822 (אפשר להשמיט את אזור הזמן), Mon, 15 Jan 2001 14:56:00
- תסדיר RFC 850 (אפשר להשמיט את אזור הזמן), Monday, 15-Jan-2001 14:56:00
- תסדיר C ctime, Mon Jan 15 14:56:00 2001
- שניות מאז 1970-01-01T00:00:00Z בתור מספר שלך בין 1 ל־13 (לא כולל 0)
- המחרוזת now
- מפריד ערכים מרובים חלופי
- פרמטרים שלוקחים ערכים מרובים בדרך־כלל נשלחים עם הערכים מופרדים באמצעות תו מקל, למשל param=value1|value2 או param=value1%7Cvalue2. אם הערך צריך להכיל את תו המקל, יש להשתמש ב־U+001F (מפריד יחידות) בתור המפריד וגם להוסיף לתחילת הערך U+001F, למשל param=%1Fvalue1%1Fvalue2.
קרדיטים
מפתחי ה־API:
- רואן קטאו (מפתח מוביל 2007–2009)
- ויקטור וסילייב
- בריאן טונג מין
- סאם ריד
- יורי אסטרחן (יוצר, מפתח מוביל מספטמבר 2006 עד ספטמבר 2007)
- בראד יורש (מפתח מוביל מאז 2013)
אנא שלחו הערות, הצעות ושאלות לכתובת mediawiki-api@lists.wikimedia.org או כתבו דיווח באג באתר https://phabricator.wikimedia.org.