4.0 API Documentation

General Interworx Control Panel Info News & Announcements
#1

Hey guys! Just wanted to get the word out that the new API is documented now.

Very detailed specs for all actions are here:

Let us know if you do something neat with it :slight_smile:

Tim

#2

Hi there,
Can someone make an example xml that I can post for changing an FTP account.
I try to do this with soapUI but it doesn’t work, so there must be something wrong with my XML.
Regards,
Michel

#3

Here’s an example using SOAP:


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://xml.apache.org/xml-soap" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Body><SOAP-ENV:route><apikey xsi:type="ns1:Map"><item><key xsi:type="xsd:string">email</key><value xsi:type="xsd:string">YOUREMAIL</value></item><item><key xsi:type="xsd:string">password</key><value xsi:type="xsd:string">YOURPASSWORD</value></item><item><key xsi:type="xsd:string">YOURDOMAIN</key><value xsi:type="xsd:string">test.com</value></item></apikey><ctrl_name xsi:type="xsd:string">/siteworx/ftp</ctrl_name><action xsi:type="xsd:string">edit</action><input xsi:type="ns1:Map"><item><key xsi:type="xsd:string">user</key><value xsi:type="xsd:string">ftp</value></item><item><key xsi:type="xsd:string">password</key><value xsi:type="xsd:string">newpassword</value></item><item><key xsi:type="xsd:string">confirm_password</key><value xsi:type="xsd:string">newpassword</value></item></input></SOAP-ENV:route></SOAP-ENV:Body></SOAP-ENV:Envelope>

Sorry it’s one massive line, I didn’t want to cause syntax errors trying to format it.

Tim

#4

Thank you very much!!

#5

Any way to grab bandwidth and disk usage information?

#6

I don’t know if with the V 4.0 it still work, and I know it isn’t an API, but some times ago I used something like this

SELECT name AS domain, month, year,
((in_bytes + out_bytes) /1073741824) AS total_gigabytes
FROM package_bandwidth, domains
WHERE package_bandwidth.domain_id = domains.domain_id
AND year = 2005
AND MONTH = ‘march’
GROUP BY domain, month, year

#7

Look for

API Controller : /nodeworx/siteworx
Action: querySiteworxAccountDetails

Domain : yourdomain.com
account_data : storage_used, bandwidth_used

More info here : http://interworx.com/support/docs/iworx-cp/developer/api-spec#ctrl_nodeworx_siteworx_querysiteworxaccountdetails