API:Filerevert
This page is part of the MediaWiki Action API documentation. |
Filerevert | ||
---|---|---|
Revert a file to an old version. This module cannot be used as a generator. | ||
Prefix | none | |
Required rights | edit, upload | |
Post only? | Yes | |
Generated help | Current | |
Version added |
|
POST request to revert a file to an old version.
Token
editTo 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
editfilename
: 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 withiilimit
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
editIn 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
editRevert Wiki.png to the version from 15:27:40, 5 March 2011.
api.php? action=filerevert& filename=Wiki.png& comment=Revert& archivename=20110305152740!Wiki.png& token=0123456789012345678901234567890123456789%2b%5c [try in ApiSandbox]
Result |
---|
{
"filerevert": {
"result": "Success"
}
}
|
The following documentation is the output of Special: |
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.
Example:
- Revert Wiki.png to the version of 2011-03-05T15:27:40Z.
- api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC [open in sandbox]