Table of Contents

Class OverkizServer

Namespace
OverKizApi.Models
Assembly
OverKizApi.dll

Describes a named Overkiz-compatible cloud server endpoint. Instances are stored in SupportedServers and passed to OverkizClient on construction.

public sealed class OverkizServer
Inheritance
OverkizServer
Inherited Members

Properties

ConfigurationUrl

Optional URL of the end-user configuration portal for this server.

public string? ConfigurationUrl { get; init; }

Property Value

string

Endpoint

Base URL of the Overkiz enduserAPI for this server.

public required string Endpoint { get; init; }

Property Value

string

Manufacturer

Name of the hardware manufacturer or reseller associated with this server.

public required string Manufacturer { get; init; }

Property Value

string

Name

Human-readable display name of the server / brand (e.g. "Somfy (Europe)").

public required string Name { get; init; }

Property Value

string

RequiresGatewaySelection

Whether requests to this server must be scoped to a selected gateway via a custom header.

public bool RequiresGatewaySelection { get; init; }

Property Value

bool