API:Import

This page is part of the MediaWiki API documentation.

Language:	English

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • Etiquette and usage limits
• Tutorial
• Formats
• Error reporting
• Restricting usage
• Cross-site requests
• Authentication
  • Login
  • Logout
  • Account creation
• Queries
  • Meta information
  • Properties
  • Lists
• Search suggestions
• Parsing wikitext and expanding templates
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Send email
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
  • User options
• Watchlist feed
• Wikidata
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
• Client code

MediaWiki version:

= 1.15

Token

To import pages, an import token is required. This token is equal to the edit token and the same for all pages, but changes at every login. An import token can be obtained as follows: Obtaining an import token

api.php?action=query&prop=info&intoken=import&titles=Main%20Page

Importing pages

Pages can be imported with action=import, either by uploading an XML file or by specifying a page from another wiki (also known as transwikiing).

Parameters

Parameters marked with (upload) are only used when importing an uploaded XML file. Similarly, parameters marked with (interwiki) are only used when importing from another wiki (transwiki).

• token: The token obtained in the previous request. Take care to urlencode the trailing +\ as %2B%5C
• summary: Summary for the import log (optional)
• xml: Uploaded XML file (upload)
• interwikisource: Wiki to import from (interwiki)
  • The possible values for this parameter differ per wiki, see $wgImportSources. If the list of possible values for this parameter is empty, interwiki imports are disabled
• interwikipage: Title of the page to import (interwiki)
• fullhistory: If set, import the full history rather than just the current revision (interwiki)
• namespace: Namespace to import to. If not set, don't change the page's namespace (interwiki)
• templates: Import all included templates as well (interwiki)

Example

Note: In these examples, all parameters are passed in a GET request just for the sake of simplicity. However, action=import requires POST requests; GET requests will cause an error.

Interwiki

Import meta:Help:ParserFunctions to the Manual namespace (namespace 100) with full history

api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory&token=58b54e0bab4a1d3fd3f7653af38e75cb%2B\

XML file

Import XML dump dump.xml (from Special:Export) to the Manual namespace (namespace 100)

api.php?action=import&xml=dumpcontentgoeshere&token=58b54e0bab4a1d3fd3f7653af38e75cb%2B\

When uploading a file, you need to use multipart/form-data as Content-Type or enctype, application/x-www-form-urlencoded will not work. The parameter xml is not a file name, but the actual content of a file.

Ruby source code example using httpclient (assumes login cookies are already in @headers)

 res = HTTPClient.post(@api_url, {
                              :action => 'import',
                              :xml => File.open("dump.xml"),
                              :token => token,
                              :format => 'xml'}, @headers)

Possible errors

All errors are formatted as:

<error code="code" info="info">

• code: notoken
  • info: The token parameter must be set
• code: cantimport
  • info: You don't have permission to import pages
• code: cantimport-upload
  • info: You don't have permission to import uploaded pages
• code: nointerwikipage
  • info: The interwikipage parameter must be set
• code: nofile
  • info: You didn't upload a file
• code: filetoobig
  • info: The file you uploaded is bigger than the maximum upload size
• code: partialupload
  • info: The file was only partially uploaded
• code: notempdir
  • info: The temporary upload directory is missing
    • This generally means the server is broken or misconfigured
• code: cantopenfile
  • info: Couldn't open the uploaded file
    • This generally means the server is broken or misconfigured
• code: badinterwiki
  • info: Invalid interwiki title specified
• code: import-unknownerror
  • info: Unknown error on import: ``error''

See also

• Exporting pages