ColdFusion Administrator API Web Service

Projects Add comments

Project Home :: Blog :: Forums :: Wiki

This Web Service API is a web service extension to allow remote communication with the ColdFusion administrator on your web servers. Support for ColdFusion 6.1, 7 and 8.

 

Coldfusion 6.1 support is however being discontinued.

Originally developed for the HELM hosting control panel to allow direct ColdFusion administrator integration for creating ColdFusion Datasources in HELM3. HELM4 has since been released and has added support for creating security sandboxes.

 

It also includes a HTTPWrapper which accepts regular form posts, but this is probably of little use to anyone and was only developed for use by HELM3 as ASP could not consume the web services directly, therefore I have not bothered documenting it. But for those who want to use it, you simply pass the same attributes that you would pass to the CFC except as form fields or url variables in a form post/get.

 

For ColdFusion 6.1 it used the Service Factory and the undocumentated components used by the cfadmin, no firther features will be added for CF 6.1

For ColdFusion 7/8 the official AdminAPI is used.

 

I have to give some credit to Zhou Yu who used to work for me and who I tasked with coding my first draft of this API, and who I can also blame for how messy some of the code is. I am cleaning it up and improving it as I go along though honest :-)

 

The web service currently supports:-

 

  • Mappings

  • Datasources

  • Security Sandboxes

 

 

More features will be added as and when the HELM developers decide to support them. Next on the list is most likley to be:-

 

  • Verity Collections

  • Scheduled Tasks

  • Event Gateways

 

Current Version : 1.1.7 BETA

 

The official download can be found HERE.

The subversion source code can be found on RIAFORGE

 

Any bugs or requests please make on the forum.

 

If you find this software useful and would like to contribute towards the ongoing support and development, please feel free to make a donation using one of the buttons below.

Big thanks to Sal @ gothamweb for his donation.

.

15 responses to “ColdFusion Administrator API Web Service”

  1. James Buckingham Says:
    Hi Russ,

    Do you see any reason why this wouldn't work through an AIR app?
  2. kenby Says:
    When I'm trying to access the Cf8Adminapi.cfc I've got the following Error:

    Could not find the ColdFusion Component or Interface cfide.adminapi.webService.cf7mapping.

    and in the Helm Diagnostics I've got the following one:

    ColdFusion failed to communicate with the webservice. Reason: Error attempting to create Java skeleton for CFC web service.; nested exception is: coldfusion.xml.rpc.CFCInvocationException: [coldfusion.xml.rpc.SkeletonClassLoader$UnresolvedCFCDataTypeException : Cannot resolve CFC datatype: cfide.adminapi.webService.cf7mapping.]
  3. kEnBy! Says:
    You may want to check the Script Directory, it should be the path that you installed the CFIDE !
  4. Vlado Says:
    Hi Russ, Im using HELM4 and trying to add Coldfusion DSN. But HELM shows the same message all the time:" Failed to save a DSN Record. Reason: Your IP is not allowed!"
    Im sure i have correct IP in config.cfm and just to make sure i added IP also into ip.cfm. Is there other file where i should write IP to make it work?
    Thank you .
  5. Russ Says:
    The only place you should need to add it is in the config file. Does the helm control server have any other IP's that it may be communicating with?
    I'm afraid I have nothing to do with HELM any more since Parallels took over, so I wouldn't rely my API being supported in HELM4 if I were you.
    I have moved over to DotNetPanel now.
  6. Vlado Says:
    Thank you very much for answer. There is just one IP. So i will try to fight with it. Does DotNetPanel support Coldfusion?
  7. Russ Says:
    DNP has recently added support for CF, so it does at least setup the mappings and allow you to host CF, and they do seem interested in adding more support and using my API.
    DNP just seems to have more potential and more future than HELM.
  8. Jenny Says:
    Hi Russell,
    Firstly, many thanks for this application.
    I am using CF 7 with Helm 3.
    Everything works fine until I actually try to create a DSN.
    The following error is returned.
    Unable to save DSN. Your IP (127.0.0.1) is not allowed!
    I have checked the IP is included in the config.cfm.
    I have seen references from others having the problem
    to an IP.cfm file, but I can't find this file anywhere.
    I can see the error is returned by the AdminAPIWrapper.cfm,
    but I have no idea how to correct it.
    Any help in getting this to work would be much appreciated.
    Many thanks,
    Jenny
  9. russ Says:
    the ip.cfm is in the old version, which I believe ships with helm3 or is downloadable from their site. If you downloaded the version from my site then the IP's are in the config file, this version was updated for use with helm4. So you may want to get the original version for use with helm3, I do not know where on the parallels site to get it from though.
  10. Jenny Says:
    Sadly the old version is no longer available on the Parallels
    site and the version they have sent me is the new/wrong one.
    Would it be possible for you to send this to me, please, or
    tell me where I can get it?
    Many thanks,
    Jenny
  11. Russ Says:
    Your best bet would be to ask on the helm forums, someone there will still have it and be using it.
  12. Jenny Says:
    Hmm .. to think I was going to donate ... thanks so much ?
  13. Russ Says:
    \Hmm, to think, I tried to help
  14. Jenny Says:
    Ok, please excuse me if I am wrong, but i was under the
    impression that you created this api? I thought it might
    be a simple process for you to email me the zip?
    Sorry if I am frustrated but i've been working on this for
    some days and getting nowhere.
  15. Jenny Says:
    For anyone else experiencing the same problem as Vlado and I,
    a link to the correct API can be found here:
    http://download.webhostautomation.net/CFMX/

Leave a Reply

Leave this field empty

Powered by Mango Blog. Design and Icons by N.Design Studio