| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | Next |
Input parameters:
- [clientName] : string : client search filter
- [orderArray] : OrderArray : search order structure
Output parameters:
- Returns an ArrayOfClientInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_LISTCLIENTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin
Necessary permissions: none
Remarks:
- Return the client list created on the Cube Panel server.
- The clientName parameter allows for the client name search filter.
- The order can be performed by the following parameters:
* server : name of Cube Panel server
* status : client status
* register : client's ability to register domains
* date : client creation date
* ndomains : number of client domains
* company : name of client's company
* username : login of the client
Examples:
.NET Java PHP
Input parameters:
- login : string: username to be used in the Cube Panel server
- password : string : new client password
- [company] : string : client's company name
- [contact] : string : client contact name
- [phone] : string : client telephone number
- [fax] : string : client fax number
- email : string : client email
- [address] : string : client address
- [city] : string : client city
- [state] : string : client state/province
- [postalCode] : int: client postcode
- [country] : int : country ID
- idLanguage : int : language ID
- idTemplate : int : client template ID used to create client
- panelIp : int : IP identification for the panel in which the client is installed.
- panelPort : int : default 8443
- [panelHostName] : string : domain name where the client will access (and his domains) the control panel
- [fiscalid] : string : client fiscal ID
- [taxes] : int : VAT percentage to be applied to client invoices.
- [idCurrency] : Invoice currency ID.
Output parameters:
- Return a int with the created user ID
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_ADDNEWCLIENT
- ERROR_ADMINCLIENTS_CLIENTCREATEDWITHERRORS
- ERROR_ADMINCLIENTS_TEMPLATEIDNOTEXISTS
- ERROR_ADMINCLIENTS_NEEDBILLINGDATA
- ERROR_ADMINCLIENTS_LOGINEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin
Necessary permissions: none
Remarks:
- This web service adds a new client from a template specifying the applicable limits and permissions.
- fiscalId, taxes and idCurrency are only needed if using the "Domain Registry" module with the client.
Examples:
.NET Java PHP
Input parameters:
- clientId: int : ID of client to be deleted
Output parameters:
- Return "true" if the client is going to be deleted.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_CLIENT_LOCKED
- ERROR_ADMINCLIENTS_REMOVECLIENT
Callable by: admin
Necessary permissions: none
Remarks:
- Web service checks to see that there is no block on the client or any of its domains.
- The deletion is queued on the server and deletes all resources being used by the domains, the domains themselves and the client.
Examples:
.NET Java PHP
Input parameters:
- [idresources] : ArrayOfInt: array of resource Ids to get their usage.
- clientId : Client ID to get usage.
- [extraParams] : ArrayOfResourceExtraParam : extra necessary parameters to check usage of some resources.
Output parameters:
- Return a complex instruction ArrayOfResourceUsage with the client usage requested.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_GETRESOURCEUSAGE
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin
Necessary permissions: none
Remarks:
- Web service calculates the total resource usage selected for the specified client. Usage corresponds to the resources used by the client domains plus the specified usage of the client.
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:
- [orderArray] : OrderArray : results order
Output parameters:
- Return an array of complex type ArrayOfClientTemplateInfo with the client template created on the server.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_LISTTEMPLATES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin
Necessary permissions: none
Remarks:
- Return the client templates created on the server.
- The order structure can be with the following parameters:
* serverName : name of Cube Panel server
* date : template creation date
* name : template name
Examples:
.NET Java PHP
Input parameters:
- clientId : int : client id
Output parameters:
- Return an array of complex type ArrayOfAdminIp with the panel IPs that can be assigned to the client.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_ADMINCLIENTS_LISTTEMPLATES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: admin
Necessary permissions: none
Remarks:
- Return the IPs that can be assigned to client clientId.
Examples:
.NET Java PHP