Namespace KASserver

Classes

AccountQuota: The resource quotas of a subaccount, shared by add_account and update_account. Only properties that are set (non-null) are sent. On add_account an unset quota means the KAS default (0 = unlimited/none depending on the resource); on update_account it means the value stays unchanged. All values must be non-negative.

AccountResource: The usage figures of a single account resource (one entry of get_accountresources), e.g. webspace or mailboxes. Field shape verified live against the KAS API.

AccountResources: The account resource quotas and usage as returned by get_accountresources. The KAS API returns a map keyed by resource name (max_webspace, max_domain, …) where each value holds the max/used/free/… figures. Field shape verified live against the KAS API.

AccountSettings: The account settings as returned by get_accountsettings (the inner settings map). Typed convenience properties cover the most common fields; Raw exposes the complete map for everything else. Field shape verified live against the KAS API.

AddAccount: Parameters for creating a subaccount (add_account). Requires a superuser login.

AddDnsRecord: Parameters for creating a DNS resource record (add_dns_settings). The record type can be given either as a DnsRecordType via Type or as a raw KAS string via RawType — exactly one of the two must be set.

AddDynDnsUser: Parameters for creating a DynDNS user (add_ddnsuser). The user updates the A/AAAA record of {Label}.{Zone} via DynDNS; KAS generates the technical DynDNS login.

AddMailAccount: Parameters for creating a mailbox (add_mailaccount).

AddMailForward: Parameters for creating a mail forward (add_mailforward).

AddSubdomain: Parameters for creating a subdomain (add_subdomain). The new host is {SubdomainName}.{DomainName}. Only the two name parts are required; every other property is optional and only sent when set, leaving the KAS defaults in place (redirect_status = no redirect, statistic_version = 5, statistic_language = de, php_version = 7.1).

DnsRecord: A DNS resource record as returned by get_dns_settings. Typed convenience properties cover the common fields; Raw exposes the complete map for everything else.

DynDnsUser: A DynDNS user as returned by get_ddnsusers. Typed convenience properties cover the common fields; Raw exposes the complete map for everything else.

KasApiException: Thrown when the KAS API returns a SOAP fault (e.g. kas_session_invalid, email_already_exists, missing_parameter) or when a response cannot be interpreted (non-XML body, unexpected response shape).

KasResponse: A parsed KAS API response (the Response map of a successful call).

KasServerDefaults: Shared constants for the KAS API client.

KasServerOptions: Configuration options for the KAS API client.

MailAccount: A mailbox as returned by get_mailaccounts. Typed convenience properties cover the most common fields; Raw exposes the complete map for everything else.

MailForward: A mail forward as returned by get_mailforwards. Typed convenience properties cover the most common fields; Raw exposes the complete map for everything else.

ServiceCollectionExtensions: Dependency-injection extensions for registering the KAS API client.

SubAccount: A subaccount as returned by get_accounts. Typed convenience properties cover the most common fields; Raw exposes the complete map for everything else. Field shape verified live against the KAS API.

Subdomain: A subdomain as returned by get_subdomains. Typed convenience properties cover the common fields; Raw exposes the complete map for everything else.

UpdateAccount: Parameters for editing a subaccount (update_account). Only properties that are set (non-null) are sent; everything left null stays unchanged on the server. The subaccount is identified by its account_login, passed separately to UpdateAccountAsync(string, UpdateAccount, CancellationToken). At least one field must be set. Requires a superuser login.

UpdateAccountSettings: Parameters for editing your own account settings (update_accountsettings). Only properties that are set (non-null) are sent; everything left null stays unchanged on the server. At least one field must be set.

UpdateChown: Parameters for changing ownership of a path (update_chown). Requires a superuser login.

UpdateDnsRecord: Parameters for editing a DNS resource record (update_dns_settings). Only properties that are set (non-null) are sent; everything left null stays unchanged on the server. The record is identified by its record_id, passed separately to UpdateDnsRecordAsync(string, UpdateDnsRecord, CancellationToken). At least one field must be set. The record type cannot be changed via this action (the KAS API does not accept it here).

UpdateDynDnsUser: Parameters for editing a DynDNS user (update_ddnsuser). Only properties that are set (non-null) are sent; everything left null stays unchanged on the server. The user is identified by its dyndns_login, passed separately to UpdateDynDnsUserAsync(string, UpdateDynDnsUser, CancellationToken). At least one field must be set.

UpdateMailAccount: Parameters for editing a mailbox (update_mailaccount). Only properties that are set (non-null) are sent; everything left null stays unchanged on the server. The mailbox is identified by its technical mail_login, passed separately to UpdateMailAccountAsync(string, UpdateMailAccount, CancellationToken). At least one field must be set.

UpdateSubdomain: Parameters for editing a subdomain (update_subdomain). Only properties that are set (non-null) are sent; everything left null stays unchanged on the server. The subdomain is identified by its host name, passed separately to UpdateSubdomainAsync(string, UpdateSubdomain, CancellationToken). At least one field must be set. update_subdomain only accepts subdomain_path, redirect_status and php_version — unlike AddSubdomain, the webalizer statistics fields cannot be changed here.

UpdateSuperuserSettings: Parameters for editing the superuser-controlled settings of a subaccount (update_superusersettings) — currently the SSH access and SSH keys. May only be executed by the main account. The subaccount is identified by its account_login, passed separately to UpdateSuperuserSettingsAsync(string, UpdateSuperuserSettings, CancellationToken). At least one field must be set.

Interfaces

IKasClient: High-level client for the ALL-INKL.COM KAS API. Authentication, session handling and flood throttling are handled transparently.

Enums

AccountAccessState: The KAS login access state of a subaccount (KAS kas_access_forbidden). While add_account only distinguishes allowed/forbidden, update_account additionally accepts the explicit forbidden value.

AccountHostnameKind: The kind of hostname created for a subaccount (KAS hostname_art).

AccountLogging: The web server log mode of an account (KAS logging).

AccountStatistic: The web statistics mode of an account (KAS statistic). The mapping of the de/ne values to the concrete statistics packages is to be confirmed live.

DnsRecordType: A DNS resource-record type (KAS record_type). Covers the common types; the KAS API may accept further types, which can be sent via RawType.

MailboxActiveState: The activation state of a mailbox (KAS is_active).

RedirectStatus: The redirect behaviour of a subdomain (KAS redirect_status). When None the subdomain serves the host path; otherwise it issues an HTTP redirect to the FQDN/WBK given as the subdomain path.

WebalizerLanguage: The webalizer statistics language of a subdomain (KAS statistic_language: de|en, default de).

WebalizerVersion: The webalizer statistics version of a subdomain (KAS statistic_version: 0|4|5|7, default 5). None disables the statistics.

Table of Contents

Namespace KASserver

Classes

Interfaces

Enums