עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
list=blocks (bk)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
לרשום את כל המשתמשים וכתובות ה־IP שנחסמו.
פרמטרים:
- bkstart
מאיזה חותם־זמן להתחיל למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- bkend
באיזה חותם־זמן להפסיק למנות.
- סוג: חותם־זמן (תסדירים מורשים)
- bkdir
באיזה כיוון למנות:
- newer
- לרשום את הישנים ביותר בהתחלה. לתשומת לבך: bkstart חייב להיות לפני bkend.
- older
- לרשום את החדשים ביותר בהתחלה (ברירת מחדל). לתשומת לבך: bkstart חייב להיות אחרי bkend.
- אחד מהערכים הבאים: newer, older
- ברירת המחדל: older
- bkids
רשימת מזהי חסימות לרשום (לא חובה).
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- bkusers
רשימת משתמשים לחיפוש (לא חובה).
- סוג: רשימת משתמשים, בכל אחת מהצורות הבאות: שם משתמש, כתובת IP וגם טווח כתובות IP
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- bkip
קבלת כל החסימות שחלות על טווח כתובות ה־IP הזה או את טווח ה־CIDR הזה, כולל חסימות טווח. לא יכול לשמש יחד עם bkusers. טווחי CIDR רחבים מ־IPv4/16 או IPv6/19 אינם מתקבלים.
- bklimit
המספר המרבי של חסימות לרשום.
- סוג: מספר שלם או max
- הערך חייב להיות בין 1 ל־500.
- ברירת המחדל: 10
- bkprop
אילו מאפיינים לקבל:
- id
- הוספת מזהה החסימה.
- user
- הוספת שם המשתמש שנחסם.
- userid
- הוספת המזהה של המשמש שנחסם.
- by
- הוספת שם המשתמש שחסם.
- byid
- הוספת מזהה המשתמש שחסם.
- timestamp
- הוספת חותם־הזמן של החסימה.
- expiry
- הוספת חותם־הזמן של תפוגת החסימה.
- reason
- הוספת הסיבה שניתנה לחסימה.
- range
- הוספת טווח כתובות ה־IP שהחסימה משפיעה עליהן.
- flags
- מתייג את ההחרמה (autoblock, anononly, וכו').
- restrictions
- הוספת הגבלות החסימה החלקית אם החסימה אינה לכל האתר.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): by, byid, expiry, flags, id, range, reason, restrictions, timestamp, user, userid
- ברירת המחדל: id|user|by|timestamp|expiry|reason|flags
- bkshow
להציג רק פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק חסימות ללא לצמיתות על כתובות IP יש להגדיר bkshow=ip|!temp.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): !account, !ip, !range, !temp, account, ip, range, temp
- bkcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
דוגמאות:
- רשימת חסימות.
- api.php?action=query&list=blocks [פתיחה בארגז חול]
- רשימת חסימות של המשתמשים Alice ו־Bob.
- api.php?action=query&list=blocks&bkusers=Alice|Bob [פתיחה בארגז חול]