Documentation

add_account()

Anlegen eines Accounts


    
                    add_account(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
account_kas_password: KAS-Passwort des neuen Accounts
account_ftp_password: FTP-Passwort des neuen Accounts
account_comment: der Accountkommentar (optional, default = hostname_part1.hostname_part2)
account_contact_mail: die Kontakt-Email (optional)
hostname_art: Art des Accounts: domain|subdomain|, = ohne Host

domain:einen Subdomainaccount anlegen
subdomain:einen Subdomainaccount anlegen
leer lassen:einen Account ohne Host anlegen

hostname_part1:
- wenn hostname_art=domain: das Domainlabel (z.B.: "meine-domain")
- wenn hostname_art=subdomain: das Subdomainlabel (z.B.: "forum")
hostname_part2:
- wenn hostname_art=domain: das TLD Label (z.B.: "com" oder "de")
- wenn hostname_art=subdomain: die Domain zur Subdomain (z.B.: "meine-domain.de")
hostname_path: Pfad zum Hostnamen (optional, default /hostname_part1.hostname_part2/)
max_account: maximale Anzahl an Unteraccounts, die der Account anlegen darf (optional, default 0)
max_domain: maximale Anzahl an Domains (optional, default 0)
max_subdomain: maximale Anzahl an Subdomains (optional, default 0)
max_webspace: maximaler Speicherplatz in MB (optional, default 0)
max_mail_account: maximale Anzahl an Postfächern (optional, default 0)
max_mail_forward: maximale Anzahl an Weiterleitungen (optional, default 0)
max_mailinglist: maximale Anzahl an Mailinglisten (optional, default 0)
max_database: maximale Anzahl an MySQL Datenbanken (optional, default 0)
max_ftpuser: maximale Anzahl an zusätzlichen FTP-Nutzern (optional, default 0)
max_sambauser: maximale Anzahl an Netzlaufwerken (optional, default 0)
max_cronjobs: maximale Anzahl an Cronjobs (optional, default 0)
max_wbk: maximale Anzahl an WBKs (optional, default 0)
inst_htaccess: darf Verzeichnisschutz nutzen (optional, default Y)
kas_access_forbidden: Zugang zum KAS sperren (optional, default N)
inst_software: darf Softwareinstallation nutzen (optional, default Y)
logging: Log-Einstellung: voll|kurz|ohneip|keine (optional, default keine)
logage: Logs werden nach x Tagen entfernt: 1-999 (optional, default 190)
statistic: Statistiken (=/usage) erzeugen; in welcher Sprache? 0|de|ne (optional, default 0)
dns_settings: darf DNS Einstellungen nutzen (optional, default N)
show_password: Hinweis zum Anzeigen der Passwörter (optional, default N)

add_cronjob()

Anlegen eines Cronjobs


    
                    add_cronjob(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
protocol: Cronjob Protokoll: http|https
http_url: die Cronjob-URL
cronjob_comment: der Cronjobkommentar
minute: die ausführende Minute: */1-59|0-59|*
hour: die ausführende Stunde: */1-23|1-23|*
day_of_month: der ausführende Tag des Monats: 0-31|*
month: der ausführende Monat: *
day_of_week: der ausführende Wochentag: 0-7|* (Sonntag =0 oder =7)
http_user: der HTTP-Auth Benutzer (optional)
http_password: das HTTP-Auth Passwort (optional)
mail_address: die Mailadresse, welche die Bestätigungsmail erhält: RFC2822 (optional)
mail_condition: Bedingungswort: erscheint dieses in der Scriptausgab, so wird _keine_ E-Mail versendet (optional)
mail_subject: verwende cronjob_comment als E-Mail-Subject: default|comment (optional, default)
is_active: der Cronjob ist aktiv: Y|N (optional, default Y)

Tags

add_database()

Anlegen einer Datenbank


    
                    add_database(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
database_password: das Datenbankpasswort
database_comment: der Datenbankkommentar
database_allowed_hosts: erlaubte IP Adressen, die sich zur Datenbank verbinden dürfen (optional)

add_ddnsuser()

Anlegen eines DDNS Nutzers


    
                    add_ddnsuser(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
dyndns_comment: der Kommentar
dyndns_password: das Passwort
dyndns_zone: die Zone, für welche der DDNS Benutzer angelegt werden soll, z.B. domain.tld
dyndns_label: das Label, z.B. home
dyndns_target_ip: die IP, auf die der Benutzer anfangs zeigen soll
dyndns_dual_stack: DualStack Modus (optional)

add_directoryprotection()

Anlegen eines Verzeichnisschutz-Einstellungen


    
                    add_directoryprotection(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
directory_user: das Login
directory_path: der Pfad
directory_password: das Passwort
directory_authname: der Kommentar

add_dns_settings()

Anlegen eines DNS Resource Records


    
                    add_dns_settings(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
zone_host: die betreffende Zone
record_type: der TYPE des Resource Records (MX,A,AAAA usw)
record_name: der NAME des Resource Records
record_data: die DATA des Resource Records
record_aux: die AUX des Resource Records

Tags

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: veraltet seit 2026-10-06, wird ignoriert
statistic_language: veraltet seit 2026-10-06, wird ignoriert
php_version: die gewünschte PHP Version: 5.X|7.X (optional, default 7.1)
temporary_until: Ablaufdatum der Übergangsdomain als YYYYMMDD; 0 = unbegrenzt (optional, default 0)

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_too_long
Hostname länger als 64 Zeichen (RFC 1035 / RFC 1123)
throws: hostname_forbidden
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
throws: temporary_until_syntax_incorrect

add_ftpusers()

Anlegen eines FTP Nutzers


    
                    add_ftpusers(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
ftp_password: das FTP Passwort
ftp_comment: der Kommentar
ftp_path: der Pfad zum Login (optional, default /)
ftp_permission_read: der Nutzer darf lesen: Y|N (optional, default Y)
ftp_permission_write: der Nutzer darf lesen: Y|N (optional, default Y)
ftp_permission_list: der Nutzer darf lesen: Y|N (optional, default Y)
ftp_virus_clamav: der Nutzer hat einen Virenschutz: Y|N (optional, default Y)

add_mailaccount()

Anlegen eines Mailaccounts


    
                    add_mailaccount(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
mail_password: das Mailaccountpasswort
webmail_autologin: automatisches Login vom KAS ins Webmail möglich: Y|N (optional, default Y)
local_part: der local_part, RFC2822
domain_part: FQDN, RFC2822
responder: aktiver Responder: N|Y oder start|ende (start und ende als Timestamps mit "|" als Trenner, optional, default N)
mail_responder_frequency: Sperrintervall je identischem Absender in Tagen (0 bis 4294967295); 0 beantwortet jede E-Mail (optional, default 0)
mail_responder_content_type: der Content-Type des Responder-Textes: html|text (optional, default text)
mail_responder_displayname: der Anzeigename des Absenders bei dem Autoresponder, z.B. "mein Autoresponder Max Mustermann" (optional, default leer)
responder_text: der Respondertext (optional, default leer)
copy_adress: die Kopieempfängeradressen: RFC2822 (mehrere Adressen mit Komma getrennt sind möglich, optional, default leer)
mail_sender_alias: erlaubte Aliasadressen, mit denen ein Versenden im FROM möglich ist (optional, default leer)
mail_xlist_enabled: XLIST aktiv: Y|N (optional, default Y)
mail_xlist_sent: XLIST Name "gesendete Objekte" (optional, default Sent)
mail_xlist_drafts: XLIST Name "Entwürfe" (optional, default Drafts)
mail_xlist_trash: XLIST Name "Papierkorb" (optional, default Trash)
mail_xlist_spam: XLIST Name "Spam" (optional, default Spam)
mail_xlist_archiv: XLIST Name "Archiv" (optional, default Archiv)
mail_allow_nets: Zugriffe nur für bestimmte Clients (optional, z.B. 1.2.3.4, 12.34.0.0/16, webmail)

add_mailforward()

Anlegen einer Mail-Weiterleitungen


    
                    add_mailforward(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
local_part: der local_part, RFC2822
domain_part: FQDN, RFC2822
target_N: die Weiterleitungs-Ziele RFC2822 (N als fortlaufende Nummer, optional)

add_mailinglist()

Anlegen einer Mailingliste


    
                    add_mailinglist(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
mailinglist_name: der Listenname
mailinglist_domain: der Domainname zur Liste
mailinglist_password: das Listenpasswort

add_mailstandardfilter()

Anlegen der Standardfilter für Mailkonten


    
                    add_mailstandardfilter(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
mail_login: das Mailaccount Login
filter: der Filter + Aktion: filter1:aktion1;filter2:aktion2...usw.
- Filter: siehe Rückgabe get_mailstandardfilter
- Aktionen für Filter-Type Content: delete|mark|move=verzeichnis|forward=email@adresse.tld, für alle anderen Fitler-Typen lassen Sie die Aktion bitte leer
- Beispiel: greyl;rbl_cbl:mark -> Legt den Spamfilter Greylisting und Markiert Mails deren Absender in der RBL CBL gelistet sind

Tags

add_sambauser()

Anlegen eines Netzlaufwerksnutzers


    
                    add_sambauser(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
samba_path: der Pfad
samba_new_password: das Passwort
samba_comment: der Kommentar

add_session()

Erzeugen eines Sessiontokens


    
                    add_session(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
session_lifetime: die Sessionlebenszeit in Sekunden: 1-30000
session_update_lifetime: Verlängerung der Session bei deren Benutzung: Y|N
session_2fa: der OTP Pin, falls eine 2-Faktor-Authentifizierung aktiv ist

Tags

add_softwareinstall()

Installation eines verfügbaren Softwarepaketes


    
                    add_softwareinstall(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
software_id: siehe Rückgabe get_softwareinstall
software_database: die zu verwendende Datenbank
software_database_password: das Datenbank-Passwort
software_hostname: der Hostname zur Software
software_install_example_data: falls möglich: sollen Beispieldaten installiert werden: Y|N (optional, default N)
software_path: der Pfad zur Software
software_admin_mail: die Mailadresse für die Bestätigungsmail, RFC2822
software_admin_user: der Admin-Benutzer
software_admin_pass: das Passwort für den Adminzugang
language: die Sprache in der die Bestätigungsmail verschickt wird: de|en (optional, default de)

Tags

link: Beispiel
throws: true
die Aktion wurde durchgeführt
throws: missing_parameter
ein Pflichtparameter fehlt
throws: in_progress
es wird bereits eine Software installiert
throws: install_example_data_syntax_incorrect
throws: admin_mail_syntax_incorrect
throws: admin_user_syntax_incorrect
throws: admin_user_forbidden
throws: admin_password_forbidden
throws: domain_doesnt_exist
throws: host_using_redirect
throws: kas_inst_software_forbidden
der Account darf keine Softwareinstallation nutzen
throws: language_syntax_incorrect
throws: software_database_not_found
throws: software_id_not_found
throws: software_database_password_incorrect

add_ssl_letsencrypt()

Ausstellen eines Let's-Encrypt-Zertifikats


    
                    add_ssl_letsencrypt(mixed $parameter) : mixed

Hinweis: Derzeit ist es nicht möglich, über die KAS API ein Let's-Encrypt-Zertifikat auszustellen.

Parameters

$parameter : mixed

add_subdomain()

Anlegen einer Subdomain


    
                    add_subdomain(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
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 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: veraltet seit 2026-10-06, wird ignoriert
statistic_language: veraltet seit 2026-10-06, wird ignoriert
php_version: die gewünschte PHP Version: 5.X|7.X (optional, default 7.1)
temporary_until: Ablaufdatum der Übergangsdomain als YYYYMMDD; 0 = unbegrenzt (optional, default 0)

Tags

add_symlink()

Anlegen eines Symlinks


    
                    add_symlink(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
symlink_target: das Symlinkziel
symlink_name: der Symlinkname

Tags

delete_account()

Löschen eines Accounts


    
                    delete_account(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
account_login: das zu löschene Accountlogin

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: account_has_active_subaccounts
throws: account_kas_password_for_subaccount_incorrect
throws: account_login_not_found
throws: kas_login_not_found

delete_cronjob()

Löschen eines Cronjobs


    
                    delete_cronjob(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
cronjob_id: die zu löschende Cronjob ID, siehe get_cronjobs

Tags

delete_database()

Löschen einer Datenbank


    
                    delete_database(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
database_login: das zu löschende Datenbanklogin

Tags

delete_ddnsuser()

Löschen eines DDNS Nutzers


    
                    delete_ddnsuser(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
dyndns_login: das zu löschene Login

Tags

delete_directoryprotection()

Löschen der Verzeichnisschutz-Einstellungen


    
                    delete_directoryprotection(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
directory_user: das Login
directory_path: der Pfad

Tags

delete_dns_settings()

Löschen eines DNS Resource Records


    
                    delete_dns_settings(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
record_id: die ID des Resource Records

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: dns_settings_not_allowed
throws: record_id_not_found
throws: record_id_syntax_incorrect
throws: record_is_not_changeable

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

delete_ftpuser()

Löschen eines FTP Nutzers


    
                    delete_ftpuser(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
ftp_login: das zu löschende Login

Tags

delete_mailaccount()

Löschen eines Mailaccounts


    
                    delete_mailaccount(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
mail_login: der zu löschende Mailaccount

Tags

delete_mailforward()

Löschen einer Mail-Weiterleitung


    
                    delete_mailforward(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
mail_forward: die zu löschende Mail-Weiterleitung

Tags

delete_mailinglist()

Löschen einer Mailingliste


    
                    delete_mailinglist(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
mailinglist_name: die zu löschende Mailingliste

Tags

delete_mailstandardfilter()

Löschen der Standardfilter eines Mailkontos


    
                    delete_mailstandardfilter(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
mail_login: das Login für welches die Filter entfernt werden sollen

Tags

delete_sambauser()

Löschen eines Netzlaufwerksnutzers


    
                    delete_sambauser(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
samba_login: das zu löschende Login

Tags

delete_session()

Entfernen einer Session


    
                    delete_session() : mixed

Tags

delete_subdomain()

Löschen einer Subdomain


    
                    delete_subdomain(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
subdomain_name: der zu löschende Hostname

Tags

get_accountresources()

Auslesen der Accountressourcen


    
                    get_accountresources(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

get_accounts()

Auslesen der Accounts


    
                    get_accounts(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
account_login: das gewünschte Accountlogin (optional)

Tags

get_accountsettings()

Auslesen der Accounteinstellungen


    
                    get_accountsettings(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

get_cronjobs()

Auslesen der Cronjobs


    
                    get_cronjobs(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
cronjob_id: die ID des Cronjobs (optional)

Tags

get_databases()

Auslesen der Datenbanken


    
                    get_databases(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
database_login: die gewünsche Datenbank (optional)

Tags

get_ddnsusers()

Auslesen der DDNS Nutzer


    
                    get_ddnsusers(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
ddns_login: das gewünschte DDNS Login (optional)

Tags

get_directoryprotection()

Auslesen der gesetzen Verzeichnisschutz-Einstellungen


    
                    get_directoryprotection(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
directory_path: der Pfad (optional)

Tags

get_dns_settings()

Auslesen der DNS Einstellungen einer Zone


    
                    get_dns_settings(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
zone_host: die betreffende Zone
record_id: die ID des Resource Records (optional)

Tags

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)

Jeder zurückgegebene Datensatz enthält temporary_until als Integer im Format YYYYMMDD; 0 bedeutet unbegrenzt.

Tags

get_ftpusers()

Auslesen der FTP Nutzer


    
                    get_ftpusers(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
ftp_login: das gewünschte FTP Login (optional)

Tags

get_mailaccounts()

Auslesen der Mailaccounts


    
                    get_mailaccounts(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
mail_login: das gewünschte Maillogin (optional)

Tags

get_mailforwards()

Auslesen der Mail-Weiterleitungen


    
                    get_mailforwards(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
mail_forward: die Mailweiterleitung (optional)

Tags

get_mailinglists()

Auslesen der Mailinglisten


    
                    get_mailinglists(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
mailinglist_name: die gewünsche Liste (optional)

Tags

get_mailstandardfilter()

Auslesen der Standardfilter für Mailkonten


    
                    get_mailstandardfilter(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

get_sambausers()

Auslesen der Netzlaufwerksnutzer


    
                    get_sambausers(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
samba_login: das gewünschte Login (optional)

Tags

get_server_information()

Auslesen der zusätzlichen Serverinformationen zum Account, z.B.: verfügbare PHP Versionen


    
                    get_server_information(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

get_softwareinstall()

Auslesen der verfügbaren Pakete für die automatische Softwareinstallation


    
                    get_softwareinstall(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
software_id: die betreffende Software ID (optional)

Tags

get_space()

Auslesen der Speicherbelegung


    
                    get_space(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
show_subaccounts: nur den Speicher der Unteraccounts anzeigen (optional, default N)
show_details: Details zur Speicherbelegung. Beinhaltet Informationen zu Postfächern sowie Datenbanken (optional, default N)

ohne einen optionalen Parameter gibt die Funktion die Statistik des Accounts zurück

Tags

get_space_usage()

Auslesen der Speicherbelegung einzelner Verzeichnisse


    
                    get_space_usage(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
directory: das Verzeichnis

Tags

get_subdomains()

Auslesen der Subdomains


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

Jeder zurückgegebene Datensatz enthält temporary_until als Integer im Format YYYYMMDD; 0 bedeutet unbegrenzt.

Tags

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

get_traffic()

Auslesen das Traffics


    
                    get_traffic(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
year: das Jahr (optional, default das aktuelle Jahr)
month: der Monat (optional, default der aktuelle Monat)

Tags

move_database()

Verschieben einer Datenbank


    
                    move_database(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
database_login: die zu verschiebende Datenbank
source_account: der Quellaccount
target_account: der Zielaccount
adjust_resources: Y = Limits automatisch anpassen, falls im Zielaccount keine Datenbank mehr frei ist (optional, Standard N). Erhöht werden nur die vollen Accounts vom Zielaccount aufwärts, bis ein Account Platz hat. Ist bis zum gemeinsamen übergeordneten Account von Quelle und Ziel nirgends Platz, werden die Limits des Quellaccounts und seiner übergeordneten Accounts bis dorthin um 1 gesenkt. Hat der Zielaccount Platz, wird nichts geändert.

Tags

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

move_subdomain()

Verschieben einer Subdomain


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

move_wbk()

Verschieben eines Webbaukastens (WBK)


    
                    move_wbk(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
wbk_login: der zu verschiebende WBK
source_account: der Quellaccount
target_account: der Zielaccount
adjust_resources: Y = Limits automatisch anpassen, falls im Zielaccount kein WBK mehr frei ist (optional, Standard N). Erhöht werden nur die vollen Accounts vom Zielaccount aufwärts, bis ein Account Platz hat. Ist bis zum gemeinsamen übergeordneten Account von Quelle und Ziel nirgends Platz, werden die Limits des Quellaccounts und seiner übergeordneten Accounts bis dorthin um 1 gesenkt. Hat der Zielaccount Platz, wird nichts geändert.

Tags

reset_dns_settings()

Zurücksetzen der DNS Einstellungen


    
                    reset_dns_settings(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
zone_host: die betreffende Zone
nameserver: der betreffende Nameserver (optinal, default ns5.kasserver.com)

Tags

update_account()

Bearbeiten eines Accounts


    
                    update_account(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
account_login: der zu bearbeitende Account
account_kas_password: das KAS-Passwort (optional)
max_account: maximale Anzahl an Unteraccounts, die der Account anlegen darf (optional)
max_domain: maximale Anzahl an Domains (optional)
max_subdomain: maximale Anzahl an Subdomains (optional)
max_webspace: maximaler Speicherplatz in MB (optional)
max_mail_account: maximale Anzahl an PostfÃ¤chern (optional)
max_mail_forward: maximale Anzahl an Weiterleitungen (optional)
max_mailinglist: maximale Anzahl an Mailinglisten (optional)
max_database: maximale Anzahl an MySQL Datenbanken (optional)
max_ftpuser: maximale Anzahl an zusätzlichen FTP-Nutzern (optional)
max_sambauser: maximale Anzahl an Netzlaufwerken (optional)
max_cronjobs: maximale Anzahl an Cronjobs (optional)
max_wbk: maximale Anzahl an WBKs (optional)
inst_htaccess: darf Verzeichnisschutz nutzen (optional)
inst_fpse: darf Frontpage-Servererweiterung nutzen (optional)
kas_access_forbidden: Zugang sperren (optional: N|Y|forbidden)
show_password: Hinweis zum Anzeigen der Passwörter (optional)
inst_software: darf Softwareinstallation nutzen (optional)
logging: Accesslog-Einstellung: voll|kurz|ohneip|keine (optional)
logage: Logs werden nach x Tagen entfernt: 1-999 (optional, default 190)
statistic: Statistiken (=/usage) erzeugen; in welcher Sprache? 0|de|ne (optional, default 0)
dns_settings: darf DNS Einstellungen nutzen (optional)
account_comment: der Accountkommentar (optional)
account_contact_mail: die Kontakt-Email (optional)
account_2fa: 2FA-Modus: Y|N|inherited (optional; Y kann hier nicht neu aktiviert werden, Wechsel nach N oder inherited erfordert account_kas_password)

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: account_comment_syntax_incorrect
throws: account_contact_mail_syntax_incorrect
throws: account_kas_password_syntax_incorrect
throws: account_2fa_syntax_incorrect
throws: account_2fa_cannot_be_enabled_here
throws: account_2fa_change_requires_new_password
throws: account_login_not_found
throws: couldnt_get_kas_ressources
throws: couldnt_get_subaccount_ressources
throws: dns_settings_not_allowed
throws: dns_settings_syntax_incorrect
throws: inst_fpse_not_allowed
throws: inst_fpse_syntax_incorrect
throws: inst_htaccess_not_allowed
throws: inst_htaccess_syntax_incorrect
throws: inst_software_not_allowed
throws: inst_software_syntax_incorrect
throws: kas_access_forbidden_syntax_incorrect
throws: logging_syntax_incorrect
throws: max_account_for_subaccount_gt_change_value
throws: max_account_reached
throws: max_account_syntax_incorrect
throws: max_cron_for_subaccount_gt_change_value
throws: max_cron_reached
throws: max_cron_syntax_incorrect
throws: max_database_for_subaccount_gt_change_value
throws: max_database_reached
throws: max_database_syntax_incorrect
throws: max_domain_for_subaccount_gt_change_value
throws: max_domain_reached
throws: max_domain_syntax_incorrect
throws: max_ftpuser_for_subaccount_gt_change_value
throws: max_ftpuser_reached
throws: max_ftpuser_syntax_incorrect
throws: max_mail_account_for_subaccount_gt_change_value
throws: max_mail_account_reached
throws: max_mail_account_syntax_incorrect
throws: max_mail_forward_for_subaccount_gt_change_value
throws: max_mail_forward_reached
throws: max_mail_forward_syntax_incorrect
throws: max_mailinglist_for_subaccount_gt_change_value
throws: max_mailinglist_reached
throws: max_mailinglist_syntax_incorrect
throws: max_sambauser_for_subaccount_gt_change_value
throws: max_sambauser_reached
throws: max_sambauser_syntax_incorrect
throws: max_subdomain_for_subaccount_gt_change_value
throws: max_subdomain_reached
throws: max_subdomain_syntax_incorrect
throws: max_webspace_for_subaccount_gt_change_value
throws: max_webspace_reached
throws: max_webspace_syntax_incorrect

update_accountsettings()

Bearbeiten der eigenen Accounteinstellungen


    
                    update_accountsettings(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
account_password: das KAS-Passwort (optional)
show_password: Hinweis zum Anzeigen der Passwörter (optional) (optional)
logging: Accesslog-Einstellung: voll|kurz|ohneip|keine (optional)
logage: Logs werden nach x Tagen entfernt: 1-999 (optional, default 190)
statistic: Statistiken (=/usage) erzeugen; in welcher Sprache? 0|de|ne (optional, default 0)
account_comment: der Accountkommentar (optional)
account_contact_mail: die Kontakt-Email (optional)

Tags

link: Beispiel
throws: true
die Aktion wurde durchgeführt
throws: in_progress
das KAS Objekt ist zZt noch in Bearbeitung
throws: nothing_to_do
es wurde nichts geändert
throws: account_comment_syntax_incorrect
throws: account_contact_mail_syntax_incorrect
throws: account_kas_password_syntax_incorrect
throws: logging_syntax_incorrect
throws: show_password_syntax_incorrect

update_chown()

Bearbeiten der Besitzrechte


    
                    update_chown(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
chown_path: der zu korrigierende Pfad
chown_user: der Zielnutzer: phpuser|kas_login (kas_login: z.B.: w0123456)
recursive: Besitzrechte rekursiv setzen: Y|N

Tags

update_cronjob()

Bearbeiten eines Cronjobs


    
                    update_cronjob(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
cronjob_id: die zu bearbeitende Cronjob-ID
protocol: Cronjob Protokoll: http|https (optional
http_url: die Cronjob-URL (optional)
cronjob_comment: der Cronjobkommentar (optional)
minute: die ausführende Minute: */1-59|0-59|* (optional)
hour: die ausführende Stunde: */1-23|1-23|* (optional)
day_of_month: der ausführende Tag des Monats: 0-31|* (optional)
month: der ausführende Monat: * (optional)
day_of_week: der ausführende Wochentag: 0-7|* (Sonntag =0 oder =7, optional)
http_user: der HTTP-Auth Benutzer (optional)
http_password: das HTTP-Auth Passwort (optional)
mail_address: die Mailadresse, welche die Bestätigungsmail erhält: RFC2822 (optional)
mail_condition: Bedingungswort: erscheint dieses in der Scriptausgab, so wird _keine_ E-Mail versendet (optional)
mail_subject: verwende cronjob_comment als E-Mail-Subject: default|comment (optional)
is_active: der Cronjob 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: cronjob_id_syntax_incorrect
throws: cronjob_not_found
throws: day_of_month_or_day_of_week_incorrect
throws: day_of_month_syntax_incorrect
throws: day_of_week_syntax_incorrect
throws: hour_syntax_incorrect
throws: http_password_syntax_incorrect
throws: protocol_syntax_incorrect
throws: http_url_syntax_incorrect
throws: http_user_syntax_incorrect
throws: is_active_syntax_incorrect
throws: mail_address_syntax_incorrect
throws: mail_condition_syntax_incorrect
throws: minute_syntax_incorrect
throws: month_syntax_incorrect
throws: time_not_allowed

update_database()

Bearbeiten einer Datenbank


    
                    update_database(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
database_login: das betreffende Datenbanklogin
database_new_password: das neue Datenbankpasswort (optional)
database_comment: der Datenbankkommentar (optional)
database_allowed_hosts: erlaubte IP Adressen, die sich zur Datenbank verbinden dürfen (optional)

update_ddnsuser()

Bearbeiten eines DDNS Nutzers


    
                    update_ddnsuser(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
dyndns_login: das betreffende Login
dyndns_password: das neue Passwort (optional)
dyndns_comment: der Kommentar (optional)
dyndns_dual_stack: DualStack Modus (optional)

update_directoryprotection()

Bearbeiten der Verzeichnisschutz-Einstellungen


    
                    update_directoryprotection(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
directory_user: das Login
directory_path: der Pfad
directory_password: das neue zu setzende Passwort
directory_authname: der Kommentar

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: directory_password_syntax_incorrect
throws: directory_path_syntax_incorrect
throws: directory_user_syntax_incorrect
throws: directory_authname_syntax_incorrect

update_dns_settings()

Bearbeiten eines DNS Resource Records


    
                    update_dns_settings(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
record_id: die ID des Resource Records
record_name: der NAME des Resource Records (optional)
record_data: die DATA des Resource Records (optional)
record_aux: die AUX des Resource Records (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: dns_settings_not_allowed
throws: record_already_exists
throws: record_already_exists_as_cname
throws: record_already_exists_as_non_cname
throws: record_aux_syntax_incorrect
throws: record_has_ssl_certificate
throws: record_id_not_found
throws: record_id_syntax_incorrect
throws: record_is_not_changeable
throws: record_name_syntax_incorrect
throws: record_syntax_incorrect

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)
temporary_until: Ablaufdatum der Übergangsdomain als YYYYMMDD; 0 = unbegrenzt (optional)
ssl_proxy: veraltet seit 2026-10-06, wird ignoriert
statistic: veraltet seit 2026-10-06, wird ignoriert

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: 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
throws: temporary_until_syntax_incorrect

update_ftpuser()

Bearbeiten eines FTP Nutzers


    
                    update_ftpuser(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
ftp_login: das zu bearbeitende Login
ftp_path: der Pfad zum Login (optional)
ftp_new_password: das neue FTP Passwort (optional)
ftp_comment: der Kommentar (optional)
ftp_permission_read: der Nutzer darf lesen: Y|N (optional)
ftp_permission_write: der Nutzer darf lesen: Y|N (optional)
ftp_permission_list: der Nutzer darf lesen: Y|N (optional)
ftp_virus_clamav: der Nutzer hat einen Virenschutz: 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: ftp_comment_syntax_incorrect
throws: ftp_login_not_found
throws: ftp_login_syntax_incorrect
throws: ftp_path_syntax_incorrect
throws: ftp_permission_list_syntax_incorrect
throws: ftp_permission_read_syntax_incorrect
throws: ftp_permission_write_syntax_incorrect
throws: ftp_virus_clamav_syntax_incorrect
throws: password_syntax_incorrect

update_mailaccount()

Bearbeiten eines Mailaccounts


    
                    update_mailaccount(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
mail_login: das zu bearbeitende Login
mail_new_password: das neue Mailaccountpasswort (optional)
webmail_autologin: automatisches Login vom KAS ins Webmail möglich: Y|N (optional, default Y)
responder: aktiver Responder: N|Y oder start|ende (start und ende als Timestamps mit "|" als Trenner, optional)
mail_responder_frequency: Sperrintervall je identischem Absender in Tagen (0 bis 4294967295); 0 beantwortet jede E-Mail (optional)
mail_responder_content_type: der Content-Type des Responder-Textes: html|text (optional)
mail_responder_displayname: der Anzeigename des Absenders bei dem Autoresponder, z.B. "mein Autoresponder Max Mustermann" (optional)
responder_text: der Respondertext (optional)
copy_adress: die Kopieempfängeradressen: RFC2822 (mehrere Adressen mit Komma getrennt sind möglich, optional)
is_active: ist das Postfach aktiv: Y|N|forbidden (N: kein Empfang aber Abruf ist noch möglich, optional)
mail_sender_alias: erlaubte Aliasadressen, mit denen ein Versenden im FROM möglich ist (optional)
mail_xlist_enabled: XLIST aktiv: Y|N (optional)
mail_xlist_sent: XLIST Name "gesendete Objekte" (optional)
mail_xlist_drafts: XLIST Name "Entwürfe" (optional)
mail_xlist_trash: XLIST Name "Papierkorb" (optional)
mail_xlist_spam: XLIST Name "Spam" (optional)
mail_xlist_archiv: XLIST Name "Archiv" (optional)
mail_allow_nets: Zugriffe nur für bestimmte Clients (optional, z.B. 1.2.3.4, 12.34.0.0/16, webmail)

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: copy_adress_like_mailaccount
throws: copy_adress_syntax_incorrect
throws: email_already_exists
throws: email_domain_doesnt_exist
throws: mail_loop_detected
throws: is_active_syntax_incorrect
throws: mail_login_not_found
throws: max_sender_alias_reached
throws: password_syntax_incorrect
throws: responder_contentype_syntax_incorrect
throws: responder_displayname_syntax_incorrect
throws: responder_not_allowed_for_catchall_adresses
throws: responder_frequency_syntax_incorrect
throws: responder_startdate_gt_enddate
throws: responder_syntax_incorrect
throws: responder_text_is_empty
throws: sender_alias_domain_in_kas
throws: sender_alias_syntax_incorrect
throws: mail_xlist_enabled_syntax_incorrect
throws: mail_xlist_sent_syntax_incorrect
throws: mail_xlist_drafts_syntax_incorrect
throws: mail_xlist_trash_syntax_incorrect
throws: mail_xlist_spam_syntax_incorrect
throws: mail_xlist_archiv_syntax_incorrect
throws: mail_xlist_duplicate_folder
throws: webmail_autologin_syntax_incorrect
throws: webmail_autologin_change_requires_new_password

update_mailforward()

Bearbeiten der Mail-Weiterleitungen


    
                    update_mailforward(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
mail_forward: die zu bearbeitende Mail-Weiterleitung
target_N: die Weiterleitungs-Ziele RFC2822 (N als fortlaufende Nummer, 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: mail_forward_adress_syntax_incorrect
throws: mail_forward_not_found
throws: mail_loop_detected
throws: target_email_duplicate
throws: target_email_like_forward
throws: target_email_syntax_incorrect
throws: targets_limit_reached

update_mailinglist()

Bearbeiten einer Mailingliste


    
                    update_mailinglist(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
mailinglist_name: die zu bearbeitende Mailingliste
subscriber: die Listenteilnehmer als RFC2822 (mehrere mit Zeilenumbruch getrennt, optional)
restrict_post: die Resrict-Post-Adressen RFC2822 (mehrere mit Zeilenumbruch getrennt, optional)
config: die komplette Konfigurationsdatei als Klartext
is_active: ist die Mailingliste 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: cannot_connect_to_majordomo
throws: cannot_login_to_majordomo
throws: cannot_open_tmp_config
throws: cannot_open_tmp_restrict_post
throws: cannot_open_tmp_subscriber
throws: cannot_write_tmp_config
throws: cannot_write_tmp_restrict_post
throws: cannot_write_tmp_subscriber
throws: cannot_write_to_majordomo
throws: is_active_syntax_incorrect
throws: mailinglist_not_found
throws: mailinglist_syntax_incorrect
throws: parse_error_in_tmp_config
throws: restrict_post_email_syntax_incorrect
throws: subscriber_email_syntax_incorrect

update_sambauser()

Bearbeiten eines Netzlaufwerksnutzer


    
                    update_sambauser(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
samba_login: das Login
samba_path: der Pfad (optional)
samba_new_password: das neue Passwort (optional)
samba_comment: der neue Kommentar (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: password_syntax_incorrect
throws: path_syntax_incorrect
throws: samba_comment_syntax_incorrect
throws: samba_login_not_found
throws: samba_login_syntax_incorrect

update_ssl()

Bearbeiten eines SSL Zertifikats


    
                    update_ssl(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
hostname: der zu bearbeitende Hostname
ssl_certificate_is_active: SSL aktiv: Y|N (optional, ohne den Parameter bleibt der Status erhalten, außer Key oder CRT werden gelöscht)
ssl_certificate_sni_csr: der SSL CSR (optional)
ssl_certificate_sni_key: der SSL KEY (optional, ohne den Parameter bleibt der gespeicherte KEY erhalten, ein leerer Wert löscht ihn)
ssl_certificate_sni_crt: das SSL CRT (optional, ohne den Parameter bleibt das gespeicherte CRT erhalten, ein leerer Wert löscht es)
ssl_certificate_sni_bundle: das Bundle / Intermediate (optional)
ssl_certificate_force_https: HTTP Aufruf auf HTTPS umleiten (HTTP 301 Redirect): Y|N (optional)
ssl_certificate_hsts_max_age: HTTP Strict Transport Security (HSTS) Wert in Sekunden, -1 um zu deaktivieren (optional, ohne den Parameter bleibt der gespeicherte Wert erhalten)

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: ssl_certificate_is_active_syntax_incorrect
throws: ssl_certificate_sni_key_syntax_incorrect
throws: ssl_certificate_sni_crt_syntax_incorrect
throws: ssl_certificate_sni_crt_is_not_a_crt
throws: ssl_certificate_hostname_not_in_crt
throws: ssl_certificate_sni_csr_syntax_incorrect
throws: ssl_certificate_sni_bundle_syntax_incorrect
throws: ssl_certificate_sni_bundle_is_not_a_bundle
throws: ssl_certificate_sni_chainfile_syntax_incorrect
throws: ssl_certificate_sni_chainfile_is_not_a_chainfile
throws: ssl_certificate_sni_key_is_not_a_key
throws: ssl_certificate_hsts_max_age_syntax_incorrect
throws: ssl_certificate_force_https_syntax_incorrect

update_subdomain()

Bearbeiten einer Subdomain


    
                    update_subdomain(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
subdomain_name: der zu bearbeitende Hostname
subdomain_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)
temporary_until: Ablaufdatum der Übergangsdomain als YYYYMMDD; 0 = unbegrenzt (optional)
ssl_proxy: veraltet seit 2026-10-06, wird ignoriert
statistic: veraltet seit 2026-10-06, wird ignoriert

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: subdomain_doenst_exist
throws: subdomain_has_active_fpse
throws: subdomain_path_syntax_incorrect
throws: php_version_syntax_incorrect
throws: php_version_not_available_on_server
throws: is_active_syntax_incorrect
throws: temporary_until_syntax_incorrect

update_superusersettings()

Bearbeiten der Superuser-Accounteinstellungen


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

die Funktion darf nur vom Hauptaccount ausgeführt werden, welcher dann bestimmte Unteraccounteinstellungen bearbeiten kann.

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
account_login: das zu bearbeitende Accountlogin
ssh_access: aktiviert den SSH Zugang eines Accounts: Y|N (optional)
ssh_keys: SSH Schlüssel für die Public-Key-Authentifizierung (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: account_doesnt_belong_to_you
throws: kas_login_is_no_main_login
kas_login ist nicht der Hauptaccount
throws: settings_not_in_contract
throws: ssh_access_syntax_incorrect
throws: ssh_keys_syntax_incorrect

Table of Contents

Packages

Functions

Functions

add_account()

Parameters

Tags

add_cronjob()

Parameters

Tags

add_database()

Parameters

Tags

add_ddnsuser()

Parameters

Tags

add_directoryprotection()

Parameters

Tags

add_dns_settings()

Parameters

Tags

add_domain()

Parameters

Tags

add_ftpusers()

Parameters

Tags

add_mailaccount()

Parameters

Tags

add_mailforward()

Parameters

Tags

add_mailinglist()

Parameters

Tags

add_mailstandardfilter()

Parameters

Tags

add_sambauser()

Parameters

Tags

add_session()

Parameters

Tags

add_softwareinstall()

Parameters

Tags

add_ssl_letsencrypt()

Parameters

add_subdomain()

Parameters

Tags

add_symlink()

Parameters

Tags

delete_account()

Parameters

Tags

delete_cronjob()

Parameters

Tags

delete_database()

Parameters

Tags

delete_ddnsuser()

Parameters

Tags

delete_directoryprotection()

Parameters

Tags

delete_dns_settings()

Parameters

Tags

delete_domain()

Parameters

Tags

delete_ftpuser()

Parameters