API:Patrol

MediaWiki Action API
Basics All Query modules Get properties of pages List pages matching a criterion Get module parameters information Get meta information about the wiki and user Authentication Get tokens for data modifying operations Login Logout Assert user Accounts and Users Create an account Block or unblock a user Get the current user's watchlist as a feed Change user options Change user group membership Send an email Page Operations Parse content of a page Create and edit a page Upload a file Import a page Delete a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More... Search Search for a title or text Fetch results in an OpenSearch format Search for wiki pages near a location Search for a language Perform a prefix search for page titles Developer Utilities Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation strategy

MediaWiki version:

≥ 1.14

Token

To patrol a request, a patrol token is required. Since MediaWiki 1.17, the patrol token has no longer been the same as the edit token. The patrol token is the same for all pages, but changes at every login.

Patrol tokens can be obtained via action=query&meta=tokens with type=patrol:

api.php?action=query&meta=tokens&type=patrol [try in ApiSandbox]

Patrolling changes

You can patrol changes using action=patrol. Note that this module only accepts POST requests.

Parameters

• rcid: Recentchanges ID to patrol.
• revid: Revision ID to patrol. 1.22+
• tags: Change tags to apply to the entry in the patrol log. 1.27+
• token: The token obtained in the previous request. Take care to encode the + as %2B

Example

Patrolling rcid 242005359

api.php?action=patrol&rcid=242005359&token=123ABC [try in ApiSandbox]

Possible errors

In addition to the usual errors:

Code	Info
patroldisabled	Patrolling is disabled on this wiki
noautopatrol	You are not allowed to mark your own changes as patrolled. Only users with the autopatrol right can do this
notpatrollable	The revision rid can't be patrolled as it's too old.
nosuchrcid	There is no recent change with ID rcid.
nosuchrevid	There is no revision with ID revid.

---

---

action=patrol

(main | patrol)

• This module requires read rights.
• This module requires write rights.
• This module only accepts POST requests.
• Source: MediaWiki
• License: GPL-2.0-or-later

Patrol a page or revision.

• https://www.mediawiki.org/wiki/Special:MyLanguage/API:Patrol

Parameters:

rcid

Recentchanges ID to patrol.

Type: integer

revid

Revision ID to patrol.

Type: integer

tags

Change tags to apply to the entry in the patrol log.

Values (separate with | or alternative):

token

A "patrol" token retrieved from action=query&meta=tokens

This parameter is required.

Examples:

Patrol a recent change.

api.php?action=patrol&token=123ABC&rcid=230672766 [open in sandbox]

Patrol a revision.

api.php?action=patrol&token=123ABC&revid=230672766 [open in sandbox]