DokuWiki has a XML-RPC API which can be used to access/interact with your wiki from other applications. The API implements the Wiki RPC Interface 2.0 Specifications in the wiki.* namespace and adds additional DokuWiki specific calls in the dokuwiki.* namespace. See web services for some general notes about DokuWikis possibilities.

Plugins can add their own calls to the API using Remote Plugin components.

Questions and suggestions to extend and improve the API should be directed to the mailinglist.

1. You need at least the 2008-03-31 release of DokuWiki.
2. Enable the XML-RPC interface in the “Authentication Settings” section
3. Set the remoteuser option
4. For security reasons it's safer to allow access to the XML-RPC over HTTPS only. DokuWiki's .htaccess.dist contains some rewrite rules to do that.

You can access the XML-RPC interface via the following URLs:

http://<your wiki/domain/ip>/lib/exe/xmlrpc.php

or

https://<your wiki/domain/ip>/lib/exe/xmlrpc.php

Note: you should use an XML-RPC library instead of hand-crafting your requests.

Here is an example of how to post to the API:

POST /RPC2 HTTP/1.0
User-Agent: Frontier/5.1.2 (WinNT)
Host: betty.userland.com
Content-Type: text/xml
Content-length: 181
 
<?xml version="1.0"?>
  <methodCall>
    <methodName>examples.getStateName</methodName>
    <params>
      <param> 
        <value>
          <i4>41</i4>
        </value>
      </param> 
    </params> 
  </methodCall> 

  <?xml version="1.0"?>
    <methodCall>
      <methodName>dokuwiki.getVersion</methodName>
    </methodCall>

example put page

  <?xml version="1.0"?>
<methodCall>
	<methodName>wiki.putPage</methodName>
	<params>
		<param> 
			<value>
				<string>myputpage  
				</string>
			</value>
		</param> 
		<param> 
			<value>
				<string>This is my page content</string>
			</value>
		</param>
		<param> 
			<value>
				<struct>
					<member>
						<name>sum</name>
						<value><string>Spiceworks</string></value>
					</member>
					<member>
						<name>minor</name>
						<value><boolean>True</boolean></value>
					</member>
				</struct>
			</value>
		</param> 
	</params> 
</methodCall>

Functions are listed in the following format:

Use Remote Plugins to add other methods to the XML-RPC API.

To implement such a plugin please have a look at the remote plugins development documentation.

Since XML-RPC API Version 7 (API Version 7 is since Release Adora Belle (2012-10-13)) useful hierarchical error codes have been introduced. The following error codes can be returned by the XML-RPC Interface:

Italic rows are just categories. Only normal printed rows are returned by the interface.

• 100 → Page errors
  • 110 → Page access errors
    • 111 → User is not allowed to read the requested page
    • 112 → User is not allowed to edit the page
    • 113 → manager permission is required
    • 114 → superuser permission is required
  • 120 → Page existence errors
    • 121 → The requested page does not exist
  • 130 → Page edit errors
    • 131 → Empty page id
    • 132 → Empty page content
    • 133 → Page is locked
    • 134 → Positive wordblock check
• 200 → Media errors
  • 210 → Media access errors
    • 211 → User is not allowed to read the requested media
    • 212 → User is not allowed to delete media
    • 215 → User is not allowed to list media
  • 220 → Media existence errors
    • 221 → The requested media does not exist
  • 230 → Media edit errors
    • 231 → Filename not given
    • 232 → File is still referenced
    • 233 → Could not delete file
• 300 → Search errors
  • 310 → Argument errors
    • 311 → The provided value is not a valid timestamp
  • 320 → Search result errors
    • 321 → No changes in specified timeframe

Additionally there are some server error codes that indicate some kind of server or XML-RPC failure. The codes are the following:

• -32600 → Invalid XML-RPC request. Not conforming to specification.
• -32601 → Requested method does not exist.
• -32602 → Wrong number of parameters or invalid method parameters.
• -32603 → Not authorized to call the requested method (No login or invalid login data was given).
• -32604 → Forbidden to call the requested method (but a valid login was given).
• -32605 → The XML-RPC API has not been enabled in the configuration
• -32700 → Parse Error. Request not well formed.
• -32800 → Recursive calls to system.multicall are forbidden.
• -99999 → Unknown server error.

A number of clients written in different languages are available.