API:Import

Language:	English • 日本語

This page is part of the MediaWiki action API documentation.

MediaWiki APIs

MediaWiki action API

Import

Import pages from an XML document or another wiki.
This module cannot be used as a Generator.

Prefix

none

Required rights

importupload (upload), import (transwiki)

Post only?

Yes

Generated help

Current

Version added

≥ 1.15

Token[edit]

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. Import tokens can be obtained via action=query&meta=tokens, action=tokens with type=import (MW 1.20+), or by using the following method:

Obtaining an import token

api.php?action=query&prop=info&intoken=import&titles=Main%20Page [try in ApiSandbox]

Importing pages[edit]

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[edit]

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).

summary: Summary for the import log
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)
templates: Import all included templates as well (interwiki)
namespace: Namespace to import to. If not set, don't change the page's namespace (interwiki)
rootpage: Import as subpage of this page. Cannot be used together with namespace. 1.20+
token: The token obtained in the previous request. Take care to urlencode the trailing +\ as %2B%5C.

Example[edit]

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[edit]

Import meta:Special:MyLanguage/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\ [try in ApiSandbox]

XML file[edit]

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

api.php?action=import&xml=dumpcontentgoeshere&token=58b54e0bab4a1d3fd3f7653af38e75cb%2B\ [try in ApiSandbox]

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)

FormData[edit]

If the result says "no file" it is expecting a file in a POST body. You can easily POST using FormData.

To quote from /api.php

    xml      - Uploaded XML file
               Must be posted as a file upload using multipart/form-data

JavaScript example[edit]

For simplicity, the following code is reading the XML from a textarea and makes use of MediaWiki's JavaScript includes:

 var apiUrl = mw.util.wikiScript( 'api' );
 var onreadystatechange = function() {
	if ( 4 !== this.readyState ) return;
	if ( 200 === this.status ) {
	  console.log( this.response );
	}
 };
 
 function continueWithToken ( token ) {
	  var fd = new FormData();
	  var xhr = new XMLHttpRequest();
	  // First argument is an array!
	  var bXml = new Blob( [$( 'textarea' ).val()], {
				 type: 'text/xml'
			} );
	  fd.append( 'format', 'json' );
	  fd.append( 'action', 'import' );
	  // Third parameter is not required but
	  // You're likely on the safe side using it
	  fd.append( 'xml', bXml, 'file.xml' );
	  fd.append( 'token', token );
 
	  xhr.onreadystatechange = onreadystatechange;
	  xhr.open( 'POST', apiUrl );
	  xhr.send( fd );
 }
 
 $.get( apiUrl, {
	  format: 'json',
	  type: 'import',
	  action: 'tokens'
 } ).done( function(r) {
	  var token = r.tokens.importtoken;
	  continueWithToken( token );
 } );

This is just a minimal implementation. Do not forget error-handling. If you have the exports as files for upload and want to make it working in older browsers not sufficiently supporting Blobs and FormData, just build a HTML form. The form's target could be an iframe so you can read the response from it without exposing the blank API result page to your users.

Expected response[edit]

{"import":[{"ns":0,"title":"Main Page2","revisions":1}]}

Raw request resulting[edit]

The request that is composed by the client and sent to the server for reference. Note the file's in a POST body.

POST http://localhost/api.php HTTP/1.1
Host: localhost
User-Agent: <ua string>
Accept-Language: de,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Referer: http://localhost/index.php?title=Special:Export&action=submit
Content-Length: 3231
Content-Type: multipart/form-data; boundary=---------------------768648126486
Cookie: <redacted>; mwdbUserID=1; mwdbUserName=Rillke
Connection: keep-alive
Pragma: no-cache
Cache-Control: no-cache

-----------------------768648126486
Content-Disposition: form-data; name="format"

json
-----------------------768648126486
Content-Disposition: form-data; name="action"

import
-----------------------768648126486
Content-Disposition: form-data; name="xml"; filename="file.xml"
Content-Type: text/xml

<mediawiki ...schemas... version="0.8" xml:lang="en">
<siteinfo>
  <sitename>Sample Wiki</sitename>
<!-- .... -->
</mediawiki>
-----------------------768648126486
Content-Disposition: form-data; name="token"

XX39e9fd22a9de7675c71eadcfd2XXXX+\
-----------------------768648126486--

"Missing boundary in multipart/form-data POST data" error?

This is because you sent it url-encoded but claimed it would be multipart/form-data? MediaWiki is looking for a boundary in the header but cannot find it.

Possible errors[edit]

All errors are formatted as:

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

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

The following documentation is the output of Special:ApiHelp/import, generated from import's source code.

action=import

(main | import)

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

Import a page from another wiki, or from an XML file.

Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the xml parameter.

https://www.mediawiki.org/wiki/API:Import

Parameters:

summary: Log entry import summary.
xml: Uploaded XML file.; Must be posted as a file upload using multipart/form-data.
interwikisource: For interwiki imports: wiki to import from.; One of the following values: meta, w:en, usability
interwikipage: For interwiki imports: page to import.
fullhistory: For interwiki imports: import the full history, not just the current version.; Type: boolean (details)
templates: For interwiki imports: import all included templates as well.; Type: boolean (details)
namespace: Import to this namespace. Cannot be used together with rootpage.; One of the following values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303, 2600
rootpage: Import as subpage of this page. Cannot be used together with namespace.
token: A "csrf" token retrieved from action=query&meta=tokens; This parameter is required.

Example:

Import meta:Help:ParserFunctions to namespace 100 with full history.: api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC [open in sandbox]

API:Import

Contents

Token[edit]

Importing pages[edit]

Parameters[edit]

Example[edit]

Interwiki[edit]

XML file[edit]

FormData[edit]

JavaScript example[edit]

Expected response[edit]

Raw request resulting[edit]

Possible errors[edit]

action=import

See also[edit]

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Support

Development

MediaWiki.org

Print/export

Tools

In other languages