API documentation

You can access the API via

{{ Env.get('api_base') }}

To see it in action, have a look at the webinterface with Firebug (on firefox) or the development tools included in Chrome. All the data that you see there are from the API.

A normal API call:

{{ Env.get('api_base') }}updater.info/

You can also use the API over another domain using JSONP, the callback function should be in 'callback_func'

{{ Env.get('api_base') }}updater.info/?callback_func=myfunction

Get the API key:

{{ Env.get('web_base') }}getkey/?p=md5(password)&u=md5(username)

Will return {"api_key": "XXXXXXXXXX", "success": true}. When username or password is empty you don't need to md5 it.

{% if api_docs[route].get('params') %}

Params

{% for param in api_docs[route]['params'] %} {% end %}

{{param}}	{{ api_docs[route]['params'][param].get('type', 'string') }}	{{ api_docs[route]['params'][param]['desc'] }}

{% end %} {% if api_docs[route].get('return') %}

Return

{{ api_docs[route]['return'].get('type', '{"success": True}') }}

{% if api_docs[route]['return'].get('example') %}

Example

{{ api_docs[route]['return'].get('example', '') }}

{% end %}

CouchPotato API Documentation

{{route}}

Params

Return

Example

Missing documentation