Warning

The XML-RPC API is no longer under active development. While it is still supported, no further improvements or changes will be made to it.

We strongly recommend that you use the REST API instead.

Setup

Before using the API, you'll need to create a user and make sure you have an XML-RPC client library installed.

Creating A User

Before you can use the API, you'll need to create a user in the ActionKit Admin ( If that link doesn't work, log in to ActionKit, select the Users tab, and select "Add staff user". )

We recommend creating a user with the username "api", but it's really up to you. Once you've created a new user, be sure to update the user with an email address to which you have access; the API code may send notifications and errors to this email.

The user will need "Superuser Status," but will not need "Admin Interface" enabled. We'll be adding a more specific API permission in the future.

You can test your new account using this Python snippet:

>>> from xmlrpclib import Server
>>> actionkit = Server("https://%s:%s@%s/api/" %
...     (UserNameYouCreated, PasswordForUserYouCreated, YourActionKitHost))
>>> print actionkit.version()
This is ActionKit 0.7.6 (development)

You can verify the credentials by trying to access the API application in your browser. If they are working you'll be able to login, if not you'll get a 401 Authorization Required message.

Once you've got that working, you're ready to go!

Getting an XML-RPC Library

To use the API, you'll need an XML-RPC client library installed. XML-RPC client libraries exist in many programming languages. The examples in these docs will be in Python, but should work with any conforming XML-RPC library.