Module "subdomain"

Description

→ SOAP WSDL

Available methods

Details

void delete

Delete a subdomain by supplying its ID

Parameters

  • int $id

array get_by_domain_tld

Get all the subdomains associated with a given domain and tld

Parameters

  • string $domain
  • string $tld

Returns

  • array $details

array get_by_id

Get all the information associated with an order by supplying
its ID

Parameters

  • int $id

Returns

  • array $details

array get_by_name_domain_tld

Get all the information associated with a subdomain order by
upplying its name, domain and tld

Parameters

  • string $name
  • string $domain
  • string $tld

Returns

  • array $details

array get_by_user

Get all subdomains for a given user. This is useful to create
an "Alias" forward and stay within the current account.

Parameters

  • int $user_id

Returns

  • array $details

int get_ftp_usage

Get FTP usage

Parameters

  • int $id

Returns

  • int $ftp_usage

int get_traffic

Get total traffic for this month

Parameters

  • int $id

Returns

  • int $traffic

int has_public_stats

Has public stats

Parameters

  • string $name
  • string $domain
  • string $tld

Returns

  • int $public_stats

int insert

Insert a new \subdomain by supplying all the necessary details.

The details array can contain the following information:

user_id (*)
name (*)
domain (*)
tld (*)
type (*)
webspace
ftp_pass
feature_cgi
feature_php5
feature_php53
feature_php54
feature_php55
feature_php56
feature_php70
feature_php71
feature_php72
feature_php73
feature_php74
feature_php80
feature_php81
feature_php82
feature_php83
feature_php84
feature_ssl_letsencrypt
target

Possible values for 'type' are the following:

1 SUBDOMAIN_TYPE_A
2 SUBDOMAIN_TYPE_CNAME
3 SUBDOMAIN_TYPE_AAAA
4 SUBDOMAIN_TYPE_TXT
9 SUBDOMAIN_TYPE_DYNAMIC
11 SUBDOMAIN_TYPE_WEBSPACE_LINUX
12 SUBDOMAIN_TYPE_WEBSPACE_WINDOWS
20 SUBDOMAIN_TYPE_FORWARD_ALIAS
21 SUBDOMAIN_TYPE_FORWARD_REDIRECT
22 SUBDOMAIN_TYPE_FORWARD_REDIRECT_CLOAKED
30 SUBDOMAIN_TYPE_SRV
40 SUBDOMAIN_TYPE_NS
50 SUBDOMAIN_TYPE_MX
51 SUBDOMAIN_TYPE_MX_BACKUP
52 SUBDOMAIN_TYPE_MX_RESELLER


Items marked with (*) are mandatory.

The items webspace, ftp_pass and feature_are required for
subdomains of type "WEBSPACE_*".

The target is mandatory for all types except "WEBSPACE_*". It
can contain an IP (A, AAAA), FQDN (CNAME), URL (FORWARD_REDIRECT,
FORWARD_CLOAKED) or the id of another subdomain (FORWARD_ALIAS)

Parameters

  • array $details

Returns

  • int $id

void update

Update a subdomain by supplying all the desired details to be
updated.

See "insert" for possible values in the details array. It is not
possible to change the name, domain, tld and type.

Parameters

  • int $id
  • array $details

array validate

Validate all the associated details of a subdomain. This is
very useful when verifying user input. This also validates the
subdomain against the other DNS records if applicable.

See "insert" for possible values in the details array.

Parameters

  • int $subdomain_id
  • array $details

Returns

  • array $errors