# cpanel-lib

**Repository Path**: mirrors_samcday/cpanel-lib

## Basic Information

- **Project Name**: cpanel-lib
- **Description**: Node.js library for the cPanel/WHM API
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![build status](https://secure.travis-ci.org/vially/cpanel-lib.png)](http://travis-ci.org/vially/cpanel-lib)
Node.js library for the cPanel/WHM API
=====

## Instalation
    $ npm install cpanel-lib

## Usage
```js
var cpanel = require('cpanel-lib');

var options = {
    host: 'whm.example.com',
    port: 2087,
    secure: true,
    username: 'WHM_USERNAME',
    accessKey: 'YOUR_ACCESS_KEY'
};

var cpanelClient = cpanel.createClient(options);

cpanelClient.call('version', {}, function (err, res) {
    console.log('WHM Version: %j', res.version);
});

cpanelClient.call('listaccts', {}, function (err, res) {
    console.log('Result: %j', res);
});

cpanelClient.callApi2('AddonDomain', 'listaddondomains', {}, function (err, res) {
    console.log('Result: %j', res);
});
```

## API
    cpanelClient.call(action, params, callback)
    cpanelClient.callApi1(module, func, args, [user], callback)
    cpanelClient.callApi2(module, func, args, [user], callback)