API:Filerevert

From mediawiki.org

POST request to revert a file to an old version.

Token[edit]

To revert a file to an older version, a CSRF token is required. The CSRF token is the same for all pages, but changes at every login. CSRF tokens can be obtained via action=query&meta=tokens with type=csrf (MW 1.24+). For older versions, you can use API:Tokens (action) or API:Info to get an edit token.

Parameters[edit]

  • filename: Target filename, without the File: prefix.
  • archivename: Archive name of the revision to revert to. This should include the timestamp of the revision and the name of the file in the format: yyyyMMddhhmmss!filename. This information can be found using Imageinfo with iilimit set higher than 1. When looking at a file's page, the seconds will not be displayed; the needed archive name can be found by hovering over the older image and looking at the displayed file name. (Note that the ! will already have been urlencoded as %21.)
  • token: A CSRF token obtained as per the Tokens section, above. Take care to urlencode the trailing +\ as %2B%5C
  • comment: Upload comment.

Error Codes[edit]

In addition to the usual stuff:

Code Info
missingtitle The page you specified doesn't exist.
filerevert-badversion There is no previous local version of this file with the provided timestamp.

Example[edit]

Revert Wiki.png to the version from 15:27:40, 5 March 2011.

Result
{
  "filerevert": {
    "result": "Success"
  }
}



action=filerevert

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

Revert a file to an old version.

Specific parameters:
Other general parameters are available.
filename

Target filename, without the File: prefix.

This parameter is required.
comment

Upload comment.

Default: (empty)
archivename

Archive name of the revision to revert to.

This parameter is required.
token

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

This parameter is required.