API

Starting from RhodeCode version 1.2 a simple API was implemented. There's a single schema for calling all api methods. API is implemented with JSON protocol both ways. An url to send API request in RhodeCode is <your_server>/_admin/api

All clients need to send JSON data in such format:

{
    "api_key":"<api_key>",
    "method":"<method_name>",
    "args":{"<arg_key>":"<arg_val>"}
}

Example call for autopulling remotes repos using curl::

curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'

Simply provide

• api_key for access and permission validation.
• method is name of method to call
• args is an key:value list of arguments to pass to method

RhodeCode API will return always a JSON formatted answer:

{
    "result": "<result>",
    "error": null
}

All responses from API will be HTTP/1.0 200 OK, if there's an error while calling api error key from response will contain failure description and result will be null.

api_key:"<api_key>"
method: "pull"
args: {"repo":<repo_name>}

result:"Pulled from <repo_name>"
error:null

api_key:"<api_key>"
method: "create_user"
args: {"username": "<username>",
       "password": "<password>",
       "active":   "<bool>",
       "admin":    "<bool>",
       "name":     "<firstname>",
       "lastname": "<lastname>",
       "email":    "<useremail>"}

result:{"id": <newuserid>,
        "msg":"created new user <username>"}
error:null

api_key:"<api_key>"
method: "create_user"
args: {"name":  "<groupname>",
       "active":"<bool>"}

result:{"id": <newusersgroupid>,
        "msg":"created new users group <groupname>"}
error:null