cPanel API

Justin Furnas

• August 01, 2017 11:46

I have been trying to find information on the cpanel API documentation, but haven't really found an answer I am looking for. How extensive is it? Am I able to extract any data from it that I can from WHM? I am working on a custom portal for my customers (for invoicing and support), and would also like to include metrics for their signed-up services. Disk space usage on each server/package that they are registered to, bandwidth usage, and system resources usage. Is all of this stuff available via the api? It doesn't need to be presented in a graph style, as I am using google graphs to visually represent it, but to be able to aggragate the data so I can present it as a graph is really what I am after.

• 

  cPanelMichael

  • August 01, 2017 17:10

  Hello Justin, There's corresponding API functionality for most features in cPanel/WHM, but not all.

  I am working on a custom portal for my customers (for invoicing and support), and would also like to include metrics for their signed-up services. Disk space usage on each server/package that they are registered to, bandwidth usage, and system usage. Is all of this stuff available via the api?

  
  Here are some WHM API 1 Functions - listaccts - Software Development Kit - cPanel Documentation WHM API 1 Functions - showbw - Software Development Kit - cPanel Documentation If you have resellers, this function is available: WHM API 1 Functions - resellerstats - Software Development Kit - cPanel Documentation Let us know of any specific types of information you require and we can verify if there's a WHM API 1 function for it. Thank you.

  0
• 

  Justin Furnas

  • August 01, 2017 17:15

  You've done an amazing job replying. I actually just found the WHM API version 1 documentation that I was playing around with. One thing I was having trouble finding, was actual server stats per account/domain, but that may be something I don't ever end up using anyways. What I meant, was displaying for example, this user is using 'x amount of ram' on the system, or this user is using 'x number of processes'. Again, that may not be a metric that I use anyway, so the amount of bandwidth and resources available (number of used database vs number allowed, number of domains vs number allowed), etc may really be all I need. Thank you for the speedy reply!

  0
• 

  cPanelMichael

  • August 01, 2017 19:04

  Hello Justin, There are no API functions in cPanel & WHM that will output memory and process usage on a per-account basis. However, if you use CloudLinux, you can obtain this data with the "lveinfo" utility: Thank you.

  0

Please sign in to leave a comment.