The Cube Panel´s API 2.2 Reference Guide: Accessing Cube Panel's WebServices
Prev		Next

Chapter 2. API Reference Guide

Table of Contents
Complex types used
General WebServices
Client Administration
Domain Administration
Mailboxes
Redirecting mail
Managing mail address lists
Managing MySQL databases
Managing SQL Server databases
Managing the DNS
Web directories restrictions
Managing FTP

Complex types used

The following list contains the complex instruction sets used by the Cube Panel´s API´s WebServices.

AdminIp

Element	Type	Desc.
idIp	int	IP ID
ip	string	IP value
mask	string	Network interace mask
interface	string	Network interface name
type	string	IP Type
clients	int	Number of clients using IP
domains	int	Number of domains using IP
state	boolean	Status of IP

ClientInfo

Element	Type	Desc.
Id	int	Client ID
Name	string	Client name
Status	string	Client status
Company	string	Client's company
NumDomains	int	Number of client domains
Date	int	Creation date
IdTemplate	int	Client template ID
server	string	Client server IP
port	int	Client server port
serverName	string	Client server name
register	boolean	Status of the domain register module

ClientIP_Ip

Element	Type	Desc.
idIp	int	IP identification
ip	string	IP value
type	string	IP type (private/public/panel/principal)
domains	int	Number of domains with this IP
state	boolean	IP activation status

ClientTemplateInfo

Element	Type	Desc.
Id	int	Client template ID
Name	string	Client template name
Date	int	Client template creation date
nClients	int	Number of clients using this template
server	string	IP of the server where is the template
port	int	Port of the server where is the template
serverName	int	Name of the server where is the template

Country

Element	Type	Desc.
Id	int	Country ID
Desc	string	Country name

CurrencyInfo

Element	Type	Desc.
id	int	Currency ID
shortDesc	string	Currency acronym
symbol	string	Currency symbol
desc	string	Currency description

DetailClientInfo

Element	Type	Desc.
Login	string	Client name
Company	string	Client company
Contact	string	Client contact name
Phone	string	Client telephone number
Fax	string	Client fax number
Email	string	Client E-mail
Address	string	Client address
City	string	Client city
State	string	Client state/province
PostalCode	string	Client postcode
IdCountry	int	Client country ID
IdTemplate	int	Client template ID
IdPanelIP	int	Client panel IP Identification
PanelIP	string	Client IP panel value
PanelPort	int	Client port accessing the panel web
Register	boolean	Status of the domain register module
FiscalId	string	Client fiscal ID
Taxes	int	VAT percentage to be applied to client invoices
IdCurrency	int	Invoice currency

DNSInfo

Element	Type	Desc.
id	int	DNS entry ID
name	string	DNS entry name
idType	int	DNS entry type
type	string	Description of DNS entry type
value	string	DNS entry value
default	int	This value show if it is a user created entry or a default entry

DomainInfo

Element	Type	Desc.
id	string	Domain ID
name	string	Domain name
status	string	Client status
date	int	Domain register date
diskSpace	int	Disk space used by client (bytes)
traffic	int	Domain traffic generated (bytes)
client	string	Client name (domain owner)
templateName	string	Service Plan for domain owner
server	string	Domain server IP
port	int	Domain server port
serverName	string	Domain server name

DomainPersonalData

Element	Type	Desc.
Login	string	Domain name
Company	string	Domain company
Contact	string	Domain contact name
Phone	string	Domain telephone number
Fax	string	Domain fax number
Email	string	Domain e-mail
Address	string	Domain address
City	string	Domain city
State	string	Domain state/province
PostalCode	string	Domain postcode
Country	int	Domain country ID
IdTemplate	int	Domain template ID
IdTemplateType	int	Domain template type ID
IdIP	int	Domain's Web IP ID
IP	string	Domain's Web IP Value
IPType	string	Domain's Web IP Type (private/public/principal)
SystemUser	string	Name of the main system user of domain
SystemUserPassword	string	Password of the main system user of domain

FTPUserInfo

Element	Type	Desc.
id	int	FTP account ID
login	string	FTP account name
password	string	FTP account password
homePath	string	FTP initial access path
quota	int	FTP account reserved quota
type	string	Type of FTP account (R/RW/P)
date	int	FTP creation date

LangInfo

Element	Type	Desc.
Id	int	Language ID
Name	string	Language name
LangCode	string	Language code

ListID

Element	Type	Desc.
listID	int	Mail list ID

LoginInfo

Element	Type	Desc.
login	string	User login
password	string	User password

MailAliasInfo

Element	Type	Desc.
id	int	Mail redirection ID
name	string	Original mail address
target	int	Destination mail address
creationdate	int	Redirection creation date

MailBoxInfo

Element	Type	Desc.
id	int	Numeric mailbox ID
name	string	Email address
login	string	Mailbox login
password	string	Mailbox password
creationdate	string	Mailbox creation date

mailListInfo

Element	Type	Desc.
id	int	Numeric ID of mail list
list_email	string	Email address of list administrator
password	string	Administrator password
date	int	Mail list creation date
admin_url	string	URL access to the mail list's administration web

MysqlInfo

Element	Type	Desc.
id	int	MySQL database ID
login	string	Database name and username
password	string	Database user password
date	int	Database creation date

OrderArray

Element	Type	Desc.
orderBy	string	Order parameter (depends on the function to be used)
orderType	int	1 -> Ascending / 0 -> Descending
min	int	First element to display
max	int	Last element to display

ResourceExtraParam

Element	Type	Desc.
Name	string	Name of extra parameter
Value	string	Parameter value

ResourceUsage

Element	Type	Desc.
Id	int	Resource ID
Usage	int	Resource usage
descResource	string	Resource description
server	string	Server from which the resource has been obtained
port	int	Port from which the resource has been obtained

RestrictedDirInfo

Element	Type	Desc.
id	int	Restricted directory ID
name	string	Name of restricted directory
path	string	Restricted directory route
groups	ArrayOfInt	Number of groups in the restricted directory

RestrictedDirInfoSimple

Element	Type	Desc.
id	int	Restricted directory ID
name	string	Name of restricted directory
path	string	Restricted directory route
groups	int	Number of groups in the restricted directory

RestrictedGroupInfo

Element	Type	Desc.
id	int	User group ID
name	string	Name of user group
comment	string	Comments
users	ArrayOfInt	Users in the group

RestrictedGroupInfoSimple

Element	Type	Desc.
id	int	User group ID
name	string	Name of user group
comment	string	Comments
users	int	Number of users in the group

RestrictedUserInfo

Element	Type	Desc.
id	int	User ID
name	string	User name
password	string	User password
comment	string	Comments

SQLServerInfo

Element	Type	Desc.
id	int	SQL Server database ID
login	string	Name of database and connection user
password	string	Connection user password
date	int	Database creation date

TemplateInfo

Element	Type	Desc.
Id	int	Plan ID
Name	string	Plan name
Date	int	Plan creation date
nDomains	int	Number of domains using the plan
TemplateTypeDesc	string	Type of plan
TemplateTypeId	int	Plan ID

Prev	Home	Next
Accessing the API with Java		General WebServices