Build Status Code Climate


MasterControl is a ruby library for the cPanel/WHM API. It provides a simple and easy to use abstraction of their gross APIs.


Add this line to your application's Gemfile:

gem 'mastercontrol'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mastercontrol


Set your cPanel/WHM API key and the server hostname/ip.

Mastercontrol.server_hostname = 'XXX'
Mastercontrol.api_key = 'XXX'

Mastercontrol is designed to only use 2087 (secure) connections to your servers, there is not currently a way to force non-ssl connections, however if the need arises it may be implemented (but it will have to be a good reason).


After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to


Bug reports and pull requests are welcome on GitHub at[USERNAME]/mastercontrol. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.


The gem is available as open source under the terms of the MIT License.