Interface ExternalApiServerConfig

Configuration of the external API server, derived from the external API preferences.

interface ExternalApiServerConfig {
    delivery: ExternalApiDelivery;
    hostname: string;
    port: number;
    token?: string;
}

Properties

Whether and how the external API is served.

hostname: string

Hostname or IP address to bind the server to. Only used with separatePort delivery.

port: number

Port to serve the external API on. Only used with separatePort delivery.

token?: string

Bearer token required on protected external API routes. When undefined, all routes are served without verification.