KAS API Dokumentation
Back to top  

Functions

Anlegen einer Domain

add_domain(array $parameter) 
link Beispiel

Parameters

$parameter

array

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 (optional, default /)
  • 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)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\host_is_dummyhost
\domain_tld_not_allowed
\redirect_status_syntax_incorrect
\couldnt_get_kas_ressources
\domain_path_syntax_incorrect
\domain_syntax_incorrect
\hostname_syntax_incorrect
\hostname_forbidden
\statistic_syntax_incorrect
\couldnt_get_kas_ressources
\max_domain_reached
\account_is_dummyaccount das Anlegen ist in diesem Account nicht möglich
\hostname_exists_as_domain
\php_version_syntax_incorrect
\php_version_not_available_on_server

Löschen einer Domain

delete_domain(array $parameter) 
link Beispiel

Parameters

$parameter

array

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

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\domain_not_found_in_kas
\host_is_dummyhost
\subdomain_exists_in_subaccount

Auslesen der Domains

get_domains(array $parameter) 
link Beispiel

Parameters

$parameter

array

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)

Exceptions

\array_return Array mit den vorhandenen Domains im Account

Auslesen der möglichen Topleveldomains

get_topleveldomains(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

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

Exceptions

\array_return Array der Topleveldomains

Verschieben einer Domain

move_domain(array $parameter) 
link Beispiel

Parameters

$parameter

array

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

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\kas_login_syntax_incorrect
\target_is_equal_to_source
\host_is_dummyhost
\account_doesnt_belong_to_you
\target_is_dummyaccount
\domain_not_found_in_kas
\subdomain_exists_in_subaccount
\domain_has_active_fpse
\max_domain_for_subaccount_gt_change_value
\max_subdomain_for_subaccount_gt_change_value
\max_mail_account_for_subaccount_gt_change_value
\max_mail_forward_for_subaccount_gt_change_value
\max_mailinglist_for_subaccount_gt_change_value
\ddns_settings_for_subaccount_disabled

Bearbeiten einer Domain

update_domain(array $parameter) 
link Beispiel

Parameters

$parameter

array

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 (optional)
  • 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)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\nothing_to_do es wurde nichts geändert
\redirect_status_syntax_incorrect
\redirect_status
\statistic_syntax_incorrect
\domain_not_found_in_kas
\domain_path_syntax_incorrect
\domain_has_active_fpse
\php_version_syntax_incorrect
\php_version_not_available_on_server
\is_active_syntax_incorrect