API Reference

Functions, parameters, response codes, and PHP examples for the KAS API.

This reference is generated from the current KAS API metadata. Select a function to view its parameters, response codes, and a ready to use PHP example.

77 functions

Accounts

get_accountresources() Get account resources get_accounts() Get accounts get_server_information() Get additional server information for the account, e.g. available PHP versions add_account() Create an account update_account() Update an account delete_account() Delete an account

Domains

get_domains() Get domains get_topleveldomains() Get available top level domains add_domain() Create a domain update_domain() Update a domain delete_domain() Delete a domain move_domain() Move a domain

Subdomains

get_subdomains() Get subdomains add_subdomain() Create a subdomain update_subdomain() Update a subdomain delete_subdomain() Delete a subdomain move_subdomain() Move a subdomain

Email Account

get_mailaccounts() Get mail accounts get_mailstandardfilter() Get standard filters for mail accounts add_mailaccount() Create a mail account add_mailstandardfilter() Create standard filters for mail accounts update_mailaccount() Update a mail account delete_mailaccount() Delete a mail account delete_mailstandardfilter() Delete the standard filters of a mail account

Email Forwarding

get_mailforwards() Get mail forwards add_mailforward() Create a mail forward update_mailforward() Update a mail forward delete_mailforward() Delete a mail forward

Mailing List

get_mailinglists() Get mailing lists add_mailinglist() Create a mailing list update_mailinglist() Update a mailing list delete_mailinglist() Delete a mailing list

FTP

get_ftpusers() Get FTP users add_ftpuser() Create an FTP user update_ftpuser() Update an FTP user delete_ftpuser() Delete an FTP user

Database

get_databases() Get databases add_database() Create a database update_database() Update a database delete_database() Delete a database move_database() Move a database

Network Drive

get_sambausers() Get network drive users add_sambauser() Create a network drive user update_sambauser() Update a network drive user delete_sambauser() Delete a network drive user

Software Installation

get_softwareinstall() Get available packages for the automatic software installation add_softwareinstall() Install an available software package

SSL Protection

add_ssl_letsencrypt() Issue a Let's Encrypt certificate update_ssl() Update an SSL certificate

Website Builder

move_wbk() Move a website builder (WBK)

Cronjobs

get_cronjobs() Get cron jobs add_cronjob() Create a cron job update_cronjob() Update a cron job delete_cronjob() Delete a cron job

DDNS Settings

get_ddnsusers() Get dynamic DNS users add_ddnsuser() Create a dynamic DNS user update_ddnsuser() Update a dynamic DNS user delete_ddnsuser() Delete a dynamic DNS user

Directory Protection

get_directoryprotection() Get directory protection settings add_directoryprotection() Create directory protection update_directoryprotection() Update directory protection delete_directoryprotection() Delete directory protection

DNS Settings

get_dns_settings() Get the DNS settings of a zone add_dns_settings() Create a DNS resource record update_dns_settings() Update a DNS resource record delete_dns_settings() Delete a DNS resource record reset_dns_settings() Reset the DNS settings

File Management

add_symlink() Create a symbolic link update_chown() Update file ownership

Statistics

get_space() Get storage usage get_space_usage() Get the storage usage of individual directories get_traffic() Get traffic

Settings

get_accountsettings() Get account settings update_accountsettings() Update your own account settings update_superusersettings() Update superuser account settings

Sessions

add_session() Create a session token delete_session() Delete a session