Class Subdomain

Namespace

KASserver

Assembly

KASserver.Client.dll

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

public sealed class Subdomain

Inheritance

object

Subdomain

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Field shape verified live against the KAS API (get_subdomains on famgmbh.de). Note that the response field names differ from the request parameter names: the redirect status is returned as subdomain_redirect_status (the request uses redirect_status), while subdomain_name is the full host name, e.g. shop.example.com. Freshly created subdomains report in_progress = TRUE while KAS provisions them; updates are rejected with an in_progress fault until that clears.

Properties

Account

The account the subdomain belongs to (KAS field subdomain_account).

public string? Account { get; }

Property Value

string

FpseActive

Whether FrontPage Server Extensions are active (KAS field fpse_active, Y/N).

public bool FpseActive { get; }

Property Value

bool

InProgress

Whether KAS is still provisioning the subdomain (KAS field in_progress, TRUE/FALSE). Updates are rejected with an in_progress fault while this is true.

public bool InProgress { get; }

Property Value

bool

IsActive

Whether the subdomain is active (KAS field is_active, Y/N).

public bool IsActive { get; }

Property Value

bool

PhpDeprecated

Whether the configured PHP version is deprecated (KAS field php_deprecated, Y/N).

public bool PhpDeprecated { get; }

Property Value

bool

PhpVersion

The PHP version (KAS field php_version), a raw version string such as 8.5.

public string? PhpVersion { get; }

Property Value

string

Raw

The complete raw field map as returned by the KAS API.

public required IReadOnlyDictionary<string, object?> Raw { get; init; }

Property Value

IReadOnlyDictionary<string, object>

RawRedirectStatus

The raw redirect-status string as returned by KAS (KAS field subdomain_redirect_status).

public string? RawRedirectStatus { get; }

Property Value

string

RawStatisticLanguage

The raw webalizer-language string as returned by KAS (KAS field statistic_language).

public string? RawStatisticLanguage { get; }

Property Value

string

RawStatisticVersion

The raw webalizer-version string as returned by KAS (KAS field statistic_version).

public string? RawStatisticVersion { get; }

Property Value

string

Redirect

The redirect behaviour as a RedirectStatus, or null when KAS returned a value not covered by the enum (the raw string is then available via RawRedirectStatus).

public RedirectStatus? Redirect { get; }

Property Value

RedirectStatus?

Server

The server hosting the subdomain (KAS field subdomain_server).

public string? Server { get; }

Property Value

string

SslCertificateIp

Whether an IP-based SSL certificate is present (KAS field ssl_certificate_ip, Y/N).

public bool SslCertificateIp { get; }

Property Value

bool

SslCertificateSni

Whether an SNI-based SSL certificate is present (KAS field ssl_certificate_sni, Y/N).

public bool SslCertificateSni { get; }

Property Value

bool

SslProxy

Whether the SSL proxy is enabled (KAS field ssl_proxy, Y/N).

public bool SslProxy { get; }

Property Value

bool

StatisticLanguage

The webalizer statistics language as a WebalizerLanguage, or null for an unknown/missing value.

public WebalizerLanguage? StatisticLanguage { get; }

Property Value

WebalizerLanguage?

StatisticVersion

The webalizer statistics version as a WebalizerVersion, or null for an unknown/missing value.

public WebalizerVersion? StatisticVersion { get; }

Property Value

WebalizerVersion?

SubdomainName

The subdomain host name (KAS field subdomain_name), e.g. shop.example.com.

public string? SubdomainName { get; }

Property Value

string

SubdomainPath

The host path or redirect target (KAS field subdomain_path).

public string? SubdomainPath { get; }

Property Value

string