Filed with Developers [Case 33066] Request XML-API functions: park and unpark domains

[XenomediaBV]

I re-programmed the xml-api class and added a consistent method to use API1 and API2 functions along with some new functions.

The reason for this was because I really need the park and unpark domain functions. I searched this forum and found some solutions by using:

api2_query($username, 'Park', 'park', $args) 

and

api2_query($username, 'Park', 'unpark', $args) 

However, the problem is that the “park a domain”-feature must be enabled for cPanel users to be able to use this, because API1 and API2 are collection of cPanel functions which require an account username. Documentation about API1 and API2 functions: "required string - user —> The user as whom you wish to call the function."

I've this cPanel park-feature disabled to prevent users from messing up there parked domains thru there cPanel GUI. Instead a external order/billing GUI should manage parking and unparking domains (f.e. order a domain and park it directly afterwards, cancel a domain subscription and unpark it or to rearrange domains over multiple accounts; unpark and park), therefore I really need the park and unpark domain functions on a reseller/root level.

Is it possible to implement this in the XML-API collection?
WHM contains functions to manage this as well, which still works while the park-feature for cPanel users is disabled, so it’s probably possible.

Edit: Additional documentation research
* API version 1 (also known as API1), which is designed to generate output compatible with browsers. This API is used mainly to add, modify, or delete data on the server.
* API version 2 (also known as API2), which is also designed to generate output compatible with browsers. This API is used mainly to return data.

This means park and unpark should be API1 functions. The documentation for park and unpark mention that these functions belong to API2 (see documentation). Threads about park and unpark in this forum mention it should be API1. I tested both without succes.

[cPanelDavidG]

I re-programmed the xml-api class and added a consistent method to use API1 and API2 functions along with some new functions.

The reason for this was because I really need the park and unpark domain functions. I searched this forum and found some solutions by using:

api2_query($username, 'Park', 'park', $args) 

and

api2_query($username, 'Park', 'unpark', $args) 

However, the problem is that the “park a domain”-feature must be enabled for cPanel users to be able to use this, because API1 and API2 are collection of cPanel functions which require an account username. Documentation about API1 and API2 functions: "required string - user —> The user as whom you wish to call the function."

I've this cPanel park-feature disabled to prevent users from messing up there parked domains thru there cPanel GUI. Instead a external order/billing GUI should manage parking and unparking domains (f.e. order a domain and park it directly afterwards, cancel a domain subscription and unpark it or to rearrange domains over multiple accounts; unpark and park), therefore I really need the park and unpark domain functions on a reseller/root level.

Is it possible to implement this in the XML-API collection?
WHM contains functions to manage this as well, which still works while the park-feature for cPanel users is disabled, so it’s probably possible.

Edit: Additional documentation research
* API version 1 (also known as API1), which is designed to generate output compatible with browsers. This API is used mainly to add, modify, or delete data on the server.
* API version 2 (also known as API2), which is also designed to generate output compatible with browsers. This API is used mainly to return data.

This means park and unpark should be API1 functions. The documentation for park and unpark mention that these functions belong to API2 (see documentation). Threads about park and unpark in this forum mention it should be API1. I tested both without succes.

I have added your request for this functionality to our internal systems. Internal Case 33066.

Regarding seeing the park domain function as both API1 and API2, both are currently correct.

Originally the park domain function was API1 only. However, many folks wanted to use Function Hooks (designed to work with API2 functions but not API1 functions) with the the park domain function. So, due to customer demand, we added the park domain function as an API2 function to make such things easier to implement.

As a result, you will see the park domain function mentioned as both an API1 function and as an API2 function.

For those wondering about function hooks and API1, there is an alternative system called Custom Event Handlers that can be used for both API1 and API2 functions. However, one must be careful with Custom Event Handlers as a minor script error could cause all of API1 and API2 to cease functioning until the script error is resolved. That's why we recommend Function Hooks for most situations.

[XenomediaBV]

Thank you David for your additional explanation and adding my request

[cPanelMatt]

Yes, I think this is a good idea to implement as well.

I should note that in older versions of cPanel function hooks only worked with API2... this is no longer the case, any API call can now be hooked into.

[natehall]

Hi,

I know this is an old thread, however I would love to add my support for this features as it would be a great help on my current software project.

[WhiteDog]

I really need this option as well. I also have disabled direct editing of parked domains in the cPanel interface.

I would need this API to:
- park domains bought trough our ordering process
- park a <username>.ourdomain.com on top of new accounts that await a domain transfer. This way they can start preparing their site until the move. I find this works much better then using mod_userdir (no suPHP problems for one thing).

Is there a workaoround to achieve this?

For example:
- Change users feature set to allow edititng of parked domains
- park domain
- change features again