MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=upload
(main | upload)
This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0-or-later
Upload a file, or get the status of pending uploads.
Several methods are available:
- Upload file contents directly, using the file parameter.
- Upload the file in pieces, using the filesize, chunk, and offset parameters.
- Have the MediaWiki server fetch a file from a URL, using the url parameter.
- Complete an earlier upload that failed due to warnings, using the filekey parameter.
Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending the file.
- filename
Target filename.
- comment
Upload comment. Also used as the initial page text for new files if text is not specified.
Default: (empty)
- tags
Change tags to apply to the upload log entry and file page revision.
Values (separate with | or alternative):
- text
Initial page text for new files.
- watch
Deprecated.
Watch the page.
Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences (ignored for bot users) or do not change watch.
One of the following values: nochange, preferences, watch
Default: preferences
- ignorewarnings
Ignore any warnings.
Type: boolean (details)
- file
File contents.
Must be posted as a file upload using multipart/form-data.
- url
URL to fetch the file from.
- filekey
Key that identifies a previous upload that was stashed temporarily.
- sessionkey
Deprecated.
Same as filekey, maintained for backward compatibility.
- stash
If set, the server will stash the file temporarily instead of adding it to the repository.
Type: boolean (details)
- filesize
Filesize of entire upload.
Type: integer
The value must be between 0 and 104,857,600.
- offset
Offset of chunk in bytes.
Type: integer
The value must be no less than 0.
- chunk
Chunk contents.
Must be posted as a file upload using multipart/form-data.
- async
Make potentially large file operations asynchronous when possible.
Type: boolean (details)
- checkstatus
Only fetch the upload status for the given file key.
Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
This parameter is required.
Upload from a URL.
- api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC
[open in sandbox]
Complete an upload that failed due to warnings.
- api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC
[open in sandbox]
![[open in sandbox]](/Special:ApiSandbox#action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC){kind=link}
![[open in sandbox]](/Special:ApiSandbox#action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC){kind=link}