API:Revisiondelete - MediaWiki (original) (raw)

	This page is part of the MediaWiki Action API documentation.

POST request to delete and undelete revisions.

	The following documentation is the output of Special:ApiHelp/revisiondelete, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

(main | revisiondelete)

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

Delete and undelete revisions.

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

Specific parameters:

type

Type of revision deletion being performed.

This parameter is required.

One of the following values: archive, filearchive, logging, oldimage, revision

target

Page title for the revision deletion, if required for the type.

ids

Identifiers for the revisions to be deleted.

This parameter is required.

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

hide

What to hide for each revision.

Values (separate with | or alternative): comment, content, user

show

What to unhide for each revision.

Values (separate with | or alternative): comment, content, user

suppress

Whether to suppress data from administrators as well as others.

One of the following values: no, nochange, yes

Default: nochange

reason

Reason for the deletion or undeletion.

tags

Tags to apply to the entry in the deletion log.

Values (separate with | or alternative): AWB, convenient-discussions

token

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

This parameter is required.

Making any POST request is a multi-step process:

1. Log in, via one of the methods described on API:Login .
2. GET an edit/CSRF token as shown here API:Tokens
3. Send a POST request, with the CSRF token, to delete and undelete revisions.

The sample codes below cover these steps.

Hide all information about a certain revision ID. (The target, Sample Page, is unnecessary in this case.)

{ "revisiondelete": { "status": "Success", "target": "Sample Page", "items": [ { "status": "Success", "id": 71, "timestamp": "2016-12-17T03:16:23Z", "userhidden": "", "commenthidden": "", "texthidden": "", "userid": 4, "user": "Test User", "comment": "This should get revdel'd" } ] }

#!/usr/bin/python3

""" revision_delete.py

MediaWiki API Demos
Demo of `Revisiondelete` module: Hide all information about a certain revision ID.

MIT license

""" import requests

S = requests.Session()

URL = "https://test.wikipedia.org/w/api.php"

Step 1: Retrieve a login token

PARAMS_1 = { "action": "query", "meta": "tokens", "type": "login", "format": "json" }

R = S.get(url=URL, params=PARAMS_1) DATA = R.json()

LOGIN_TOKEN = DATA['query']['tokens']['logintoken']

Step 2: Send a POST request to log in. For this login

method, obtain credentials by first visiting

https://www.test.wikipedia.org/wiki/Manual:Bot_passwords

See https://www.mediawiki.org/wiki/API:Login for more

information on log in methods.

PARAMS_2 = { "action": "login", "lgname": "user_name", "lgpassword": "password", "format": "json", "lgtoken": LOGIN_TOKEN }

R = S.post(URL, data=PARAMS_2) DATA = R.json()

Step 3: While logged in, retrieve a CSRF token

PARAMS_3 = { "action": "query", "meta": "tokens", "format": "json" }

R = S.get(url=URL, params=PARAMS_3) DATA = R.json()

CSRF_TOKEN = DATA["query"]["tokens"]["csrftoken"]

Step 4: Send a POST request to hide all information about a certain revision ID.

PARAMS_4 = { "action":"revisiondelete", "type":"revision", "ids":"71", "format":"json", "hide":"content|comment|user", "reason":"Because", "token" : CSRF_TOKEN }

R = S.post(URL, data=PARAMS_4) DATA = R.text

print(DATA)