API Example Usage#

Use the following example uses of the RhodeCode Enterprise API to carry out work on your instances, or repository maintanence on the server. For the complete API documentation, see the API Documentation section.

Stripping Commits#

The strip command is useful for removing commits on the server, allowing you to push changes without using force. To strip commits on the server, use the following steps:

  1. Install RhodeCode Tools, as explained in the RhodeCode Tools Installation section.

  2. Configure the ~/.rhoderc file with the API connection details, as explained in the Configure the .rhoderc File section.

  3. Check the RhodeCode Enterprise changelog and see from which revision onwards you wish to strip commits. This will also strip all descendants.

  1. Enter your RhodeCode Tools virtual environment, using the following example:

$ . venv/bin/activate
  1. Use the API to strip a commit, or number of commits from a repository. In this example I am stripping the top two commits from ad1e0523a4ab onwards.


Repositories in repository groups require the repository group to be passed as part of the repoid.

# Run the Strip API call
$ rhodecode-api --instance-name=instance-id strip \
    repoid:repo-group/repo-name revision:ad1e0523a4ab branch:stable

# Check the JSON-RPC verification
  "error": null,
  "id": 5960,
  "result": {
    "msg": "Stripped commit ad1e0523a4ab from repo `repo-group/repo-name`",
    "repository": "repo-group/repo-name"
  1. Once the commits are stripped, you can verify that they are stripped on the web interface.