CpanelAppz.com WHM/cpanel API

[anand]

We have been working on a cpanel api from sometime now. The api is under beta release and is undergoing internal testing before its released. Many functions have already been developed and are tested working perfect.

The api is targeted towards developers who want to access whm functions however can't because of lack of api / documentation. The api tries to fill that gap.

All functions are accompanied with working demos so they can be used out of the box to plugin inside scripts.

The present functions working are:

Service Status : This function returns your server's service's status.
Server Information : This function returns complete server information.
Account List : Allows you to get accounts listing on the server. Has many multiple options, allows to show only certain details about a domain. Developer has the choice to choose which all details he wants as output/
Create Account : Create account inside cpanel
Terminate an account : Terminate account, allows the developer to terminate account using a user name / domain name. Has configurable choices.
Terminate multiple accounts : Terminate multiple accounts, works just like the terminate accounts except supports multiple accounts/
Modify Password : Modify password for a account, supports password change using a username / domain.
Suspend/Unsuspend an Account : Suspend/ unsuspend an account based on username, domain
List Suspended Accounts : Get a list of all suspended accounts
List Packages : Get a list of all packages on the server
View Bandwidth : Get bandwidth usage for a domain
List Parked Domain : View list of parked domains.

Reseller functions are being built as we speak.

ETA for launch : 10-15 days.

More information with demos will be posted soon. Next week we should be posting up a live server with the API running for any one to test it functionality.

[brentp]

Anand:

cPanel already has a status api for perl . You could also use it in php as well, theres a function laying around for that. Anyway, its in /usr/local/cpanel/Cpanel/. I also made a script with it if you didnt already know, (CGI ServUP). Available at http://brentpickup.info/servup.tar.gz. If you want to incorporate it into your scripts final release, feel free.

Regards,
Brent

[anand]

Originally Posted by brent123

Anand:

cPanel already has a status api for perl . You could also use it in php as well, theres a function laying around for that. Anyway, its in /usr/local/cpanel/Cpanel/. I also made a script with it if you didnt already know, (CGI ServUP). Available at http://brentpickup.info/servup.tar.gz. If you want to incorporate it into your scripts final release, feel free.

Regards,
Brent

Thx for the info Brent. I wasn't aware of it

However i already have that part done.

Take a look at Accounting.php.inc, it hasn't been updated with anything new in quite sometime.

I would understand that i haven't covered many functions from whm in the above listing, but once this api is released there would be a lot of functions and lot more choices to work with.

[__DoPe_ShOw__]

A few questions to anand...

1. How much will this API cost?
2. How much longer you think it'll take?
3. Can someone get a customized version?

Thanks.

[anand]

Originally Posted by __DoPe_ShOw__

A few questions to anand...

1. How much will this API cost?
2. How much longer you think it'll take?
3. Can someone get a customized version?

Thanks.

1. The cost will be disclosed once its ready to be launched, which is approx 2 weeks from now.
2. Two weeks from now.
3. We thought about it, but then decided to scrap the idea, the API would be available as a complete functions list, you are free to use what ever you want for your application.

[anand]

Updates, more features have been added

Complete Packages Management with Add,List,Edit,Delete Packages
Complete Feature Manager with Add, List, Edit Delete
Get cpanel/whm version
Get Hostname of the server running cpanel
Quota List : Get the complete list of accounts with their quota usage (allows custom fields and results)
Edit Quota : Edit quota for any user account based on their domain name / user
Add / Edit/ Delete Reseller (still in progress)

[big]

released yet ?

[anand]

Originally Posted by big

released yet ?

Nope, but more functions have been added. Just gearing up to finish the v1.0 functions list. I would say another week before things are released. Sorry about the mis leading release date mentioned earlier.

More functions added:

Add/Edit/ Delete Reseller completed
Suspend/ Unsuspend all reseller accounts
Park a domain
Change ownership of an account
Kill all reseller accounts
Reseller Stats (allows you to see how many accounts a reseller has, disk, bandwidth usage etc)
Restart Services : Covers named, exim, imap, proftpd, mysql, openssh, apache, cppop, interchange. Work for tomcat restart is in progress
Change an account's IP address (in progress)

By the weekend all the functions which will be released under the v1.0 will be finalised, next week is gonna be the licensing system setup and by the next weekend i expect to release this out.

[netlook]

Originally Posted by anand

and by the next weekend i expect to release this out.

Is it released?

[anand]

Originally Posted by netlook

Is it released?

The API is done yes, the package distribution is taking much longer than we accepted.

Anyways whatever happens this weekend our new installer is coming out, and by 27-28th the complete API with specs and examples will be released.

If you like you can PM me your contact information, we will send you a detailed mail once its launched and a link to check it out in real action.

[ThunderHostingDotCom]

What will this API do that WHM does not? Is it a stand alone program that can be run from the desktop?

[MrHits]

What is the release status?

[anand]

Originally Posted by ThunderHostingDotCom

What will this API do that WHM does not? Is it a stand alone program that can be run from the desktop?

It will allow any developer to develop scripts which can interact with almost all functions of cpanel/whm. For Example, you want to have a small interface where you can display all your server status from whm in a single screen. At present this functionality is not available via any methods. The API allows you to do so.

This is only a small example, there are several functions in the api which can be used for multiple purposes.

[anand]

Originally Posted by MrHits

What is the release status?

Sorry, i forgot that part Its already launched. We gave few people 14 day trial licenses, however we found we code make more improvements in the core engine of the api so we stopped any further licenses and started to work on it.

As of now the updates on the core will be completed by tommorow and then we should be ready to roll out the new trial licenses for people to check out. This time i will keep this thread updated.

[perlchild]

Originally Posted by anand

Sorry, i forgot that part Its already launched. We gave few people 14 day trial licenses, however we found we code make more improvements in the core engine of the api so we stopped any further licenses and started to work on it.

As of now the updates on the core will be completed by tommorow and then we should be ready to roll out the new trial licenses for people to check out. This time i will keep this thread updated.

Any way you could add to the api things that aren't really done by cpanel for now? like adding ips etc..?
I'm thinking such an api would be really helpful for automating larger transfers(a must if you are managing larger numbers of machines, and one or more needs to be deloaded on short notice)