| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | Next |
Input parameters:
- [clientId] : int : client ID of domains to be shown (indicate if the user admin requests it)
- [name] : string : name of domain to be searched within results
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfDomainInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- NOT_RESULTS_FOR_SEARCH
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin, client
Necessary permissions: none
Remarks:
- Return the client domain list (if requested by a client), or all existing domains on the server (if requested by admin user).
- the name parameter allows to filter results by domain name.
- the order may be performed by the following parameters:
* server : name of Cube Panel server (only if requested by admin user)
* name : name of domain
* status : domain status
* date : domain creation date
* diskspace : disk space used by domain
* traffic : traffic used by domain
* client : client responsible for the domain (only if requested by admin user)
* template : domain plan (only if requested by a client user)
Examples:
.NET Java PHP
Input parameters:
- [idresources] : Array : array of int with the resource IDīs to be calculated.
- [domainId] : int : domain ID selected to show resource usage
- [extraParams] : ArrayOfResourceExtraParam : extra parameters necessary to know the usage of some resources
Output parameters:
- Returns an ArrayOfResourceUsage
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTDOMAINS_DOMAINNOTOFCLIENT
- ERROR_CLIENTDOMAINS_GETRESOURCEUSAGE
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin, client, domain
Necessary permissions: none
Remarks:
- Return the usage of the selected resources in idresources for the specified domain.
If idresources is null, all resources will be returned.
- If the user requesting the WebServices is a domain type, it is not necessary to indicate the domainId parameter.
- The extra parameters used are the following:
* Month : int : select the month to see its traffic usage
* Year : int : select the year to see its traffic usage
* actualSpace : boolean : if true, it shows the disk space currently used. If false, a cached number appears (up to 1 day old)
Examples:
.NET Java PHP
Input parameters:
- login : string : name of new domain
- userPassword : string : password for the new user
- personalData : DomainPersonalData : complex type with the personal data of the domain contact
- idTemplate : int : plan ID where domain is created
- idIP : int : IP identification where the domain website is to be created
- idLanguage : int : domain language ID
Output parameters:
- Return a boolean with true if successful.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERRROR_CLIENTDOMAINS_WRONGLICENSE
- ERROR_CLIENTDOMAINS_ADDNEWDOMAIN
- ERROR_CLIENTDOMAINS_DOMAINCREATEDWITHERRORS
- ERROR_CLIENTDOMAINS_NOTPERMISSIONSFORTHISTEMPLATE
- ERROR_CLIENTDOMAINS_TEMPLATEIDNOTEXISTS
- ERROR_CLIENTDOMAINS_MASTERDNSSERVER_NEEDED
- ERROR_CLIENTDOMAINS_IPNOTEXISTS
- ERROR_CLIENTDOMAINS_LOGINEXISTS
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: client
Necessary permissions: none
Remarks:
- Create a new domain with the name selected. The domain will be created with the service plans established permission and limits (idTemplate) and the website will be created on the indicated IP.
Examples:
.NET Java PHP
Input parameters:
- domainId : int : domain ID to be deleted
Output parameters:
- Return a boolean with true value if successful.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTDOMAINS_REMOVEDOMAIN
- ERROR_PROCESSOR_DOMAIN_LOCKED
Callable by: admin, client
Necessary permissions: none
Remarks:
- Queue a domain to be deleted and block it. If the domain is already blocked, it returns error.
Examples:
.NET Java PHP
Input parameters:
- [orderArray] : OrderArray : order structure of the results
Output parameters:
- Returns an ArrayOfTemplateInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTDOMAINS_LISTTEMPLATES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin, client
Necessary permissions: none
Remarks:
- Returns the different types of plans created.
Examples:
.NET Java PHP
Input parameters:
- [idIp] : int : If different than null, all available IPs are returned except for the one indicated.
- [domainId] : int : If different than null, the IPs taken by the domain itself are also returned even though they are not available.
Output parameters:
- Returns an ArrayOfClientIP_Ip
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_CLIENTIP_GETASSIGNABLEIPS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: client
Necessary permissions: none
Remarks:
- Return IP's available to the client (shared and available private IPs).
Examples:
.NET Java PHP