Documentation

domain

Table of Contents

Functions

add_domain()  : mixed
Anlegen einer Domain
delete_domain()  : mixed
Löschen einer Domain
get_domains()  : mixed
Auslesen der Domains
get_topleveldomains()  : mixed
Auslesen der möglichen Topleveldomains
move_domain()  : mixed
Verschieben einer Domain
update_domain()  : mixed
Bearbeiten einer Domain

Functions

add_domain()

Anlegen einer Domain

add_domain(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • domain_name: Hostname ohne TLD
  • domain_tld: die TLD
  • domain_path: der Hostpfad im Account oder bei Redirect ein FQDN oder ein WBK (optional, Beispiele: /pfad/ oder http://domain.tld (redirect_status required) oder wbk:wbk000001
  • redirect_status: Redirectstatus: 0|301|302|307, 0 = kein Redirect (optional, default 0)
  • statistic_version: die Webalizerversion: 0|4|5|7 (optional, default 5)
  • statistic_language: die Webalizersprache: de|en (optional, default de)
  • php_version: die gewünschte PHP Version: 5.X|7.X (optional, default 7.1)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
host_is_dummyhost
throws
domain_tld_not_allowed
throws
redirect_status_syntax_incorrect
throws
couldnt_get_kas_ressources
throws
domain_path_syntax_incorrect
throws
domain_syntax_incorrect
throws
hostname_syntax_incorrect
throws
hostname_forbidden
throws
statistic_syntax_incorrect
throws
couldnt_get_kas_ressources
throws
max_domain_reached
throws
account_is_dummyaccount

das Anlegen ist in diesem Account nicht möglich

throws
hostname_exists_as_domain
throws
php_version_syntax_incorrect
throws
php_version_not_available_on_server

delete_domain()

Löschen einer Domain

delete_domain(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • domain_name: der zu löschende Hostname
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
domain_not_found_in_kas
throws
host_is_dummyhost
throws
subdomain_exists_in_subaccount

get_domains()

Auslesen der Domains

get_domains(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • domain_name: der gewünschte Hostname (optional)
Tags
link

Beispiel

throws
array_return

Array mit den vorhandenen Domains im Account

get_topleveldomains()

Auslesen der möglichen Topleveldomains

get_topleveldomains(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
Tags
link

Beispiel

throws
array_return

Array der Topleveldomains

move_domain()

Verschieben einer Domain

move_domain(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • domain_name: der zu bearbeitende Hostname
  • source_account: der Quellaccount
  • target_account: der Zielaccount
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
kas_login_syntax_incorrect
throws
target_is_equal_to_source
throws
host_is_dummyhost
throws
account_doesnt_belong_to_you
throws
target_is_dummyaccount
throws
domain_not_found_in_kas
throws
subdomain_exists_in_subaccount
throws
domain_has_active_fpse
throws
max_domain_for_subaccount_gt_change_value
throws
max_subdomain_for_subaccount_gt_change_value
throws
max_mail_account_for_subaccount_gt_change_value
throws
max_mail_forward_for_subaccount_gt_change_value
throws
max_mailinglist_for_subaccount_gt_change_value
throws
ddns_settings_for_subaccount_disabled

update_domain()

Bearbeiten einer Domain

update_domain(array<string|int, mixed> $parameter) : mixed
Parameters
$parameter : array<string|int, mixed>

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • domain_name: der zu bearbeitende Hostname
  • domain_path: der Hostpfad im Account oder bei Redirect ein FQDN oder ein WBK (optional, Beispiele: /pfad/ oder http://domain.tld (redirect_status required) oder wbk:wbk000001
  • redirect_status: Redirectstatus: 0|301|302|307, 0 = kein Redirect (optional)
  • php_version: die gewünschte PHP Version: modul|5.X (optional)
  • is_active: Domain ist aktiv: Y|N (optional)
Tags
link

Beispiel

throws
true

die Aktion wurde durchgeführt

throws
missing_parameter

ein Pflichtparameter fehlt

throws
in_progress

das KAS Objekt ist zZt noch in Bearbeitung

throws
nothing_to_do

es wurde nichts geändert

throws
redirect_status_syntax_incorrect
throws
redirect_status
throws
statistic_syntax_incorrect
throws
domain_not_found_in_kas
throws
domain_path_syntax_incorrect
throws
domain_has_active_fpse
throws
php_version_syntax_incorrect
throws
php_version_not_available_on_server
throws
is_active_syntax_incorrect

        
On this page

Search results