KAS API Dokumentation
Back to top  

Functions

Anlegen einer Subdomain

add_subdomain(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
  • subdomain_name: Label der Subdomain
  • domain_name: die Domain zu der das Subdomainlabel hinzu gefügt werden soll
  • subdomain_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
\account_is_dummyaccount
\domain_for_this_subdomain_doesnt_exist
\domain_syntax_incorrect
\max_subdomain_reached
\couldnt_get_kas_ressources
\redirect_status_syntax_incorrect
\statistic_syntax_incorrect
\subdomain_exist_as_subdomain
\subdomain_path_syntax_incorrect
\subdomain_syntax_incorrect
\wildcardsubdomain_not_in_contract
\php_version_syntax_incorrect
\php_version_not_available_on_server

Löschen einer Subdomain

delete_subdomain(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
  • subdomain_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
\host_is_dummyhost
\subdomain_doenst_exist

Auslesen der Subdomains

get_subdomains(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
  • subdomain_name: die gewünsche Subdomain (optional)

Exceptions

\array_return Array mit den vorhandenen Subdomains im Account

Verschieben einer Subdomain

move_subdomain(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
  • subdomain_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
\nothing_to_do es wurde nichts geändert
\kas_login_syntax_incorrect
\target_is_equal_to_source
\host_is_dummyhost
\account_doesnt_belong_to_you
\subdomain_not_found_in_kas
\no_valid_parent_domain_there
\target_is_dummyaccount
\subdomain_has_active_fpse
\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

Bearbeiten einer Subdomain

update_subdomain(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
  • subdomain_name: der zu bearbeitende Hostname
  • subdomain_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
\statistic_syntax_incorrect
\subdomain_doenst_exist
\subdomain_has_active_fpse
\subdomain_path_syntax_incorrect
\php_version_syntax_incorrect
\php_version_not_available_on_server
\is_active_syntax_incorrect