banner logo

Using the API

Requests are made to a Remote Potato Server as HTTP GET or POST requests, so ensure your client application is able to make both.

Methods are usually of the syntax:
http://hostname/xml/command/filter?token=YOURTOKEN

...where YOURTOKEN is an authentication token that you obtain and store within the API's login method.

Some API methods are merely GET requests where parameters are passed as URL-encoded strings within the URL itself.

However, for some methods, HTTP POST requests are used, with the remaining data posted to the server as part of the POST request, as a string containing an XML representation of the object to be passed to the server. (see Index of Objects)

Please note, as of v3.0 of the API, HTTP Authentication is no longer required to use the API.