@accelerated-software-development/caddy-api-client - v0.2.2
    Preparing search index...

    Interface CaddyRouteHandler

    Caddy route handler

    interface CaddyRouteHandler {
        body?: string;
        handler: string;
        headers?:
            | Record<string, string[]>
            | {
                request?: {
                    add?: Record<string, string[]>;
                    delete?: string[];
                    set?: Record<string, string[]>;
                };
                response?: {
                    add?: Record<string, string[]>;
                    delete?: string[];
                    require?: { status_code?: number[] };
                    set?: Record<string, string[]>;
                };
            };
        health_checks?: {
            active?: {
                expect_status?: number;
                interval?: string;
                path?: string;
                timeout?: string;
            };
        };
        load_balancing?: {
            policy?: string;
            selection_policy?: { policy?: string };
        };
        providers?: {
            http_basic?: {
                accounts?: { password?: string; username?: string }[];
                realm?: string;
            };
        };
        routes?: CaddyRoute[];
        status_code?: number;
        strip_path_prefix?: string;
        transport?: { protocol?: string };
        upstreams?: { dial: string }[];
        uri?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    body?: string
    handler: string
    headers?:
        | Record<string, string[]>
        | {
            request?: {
                add?: Record<string, string[]>;
                delete?: string[];
                set?: Record<string, string[]>;
            };
            response?: {
                add?: Record<string, string[]>;
                delete?: string[];
                require?: { status_code?: number[] };
                set?: Record<string, string[]>;
            };
        }
    health_checks?: {
        active?: {
            expect_status?: number;
            interval?: string;
            path?: string;
            timeout?: string;
        };
    }
    load_balancing?: { policy?: string; selection_policy?: { policy?: string } }
    providers?: {
        http_basic?: {
            accounts?: { password?: string; username?: string }[];
            realm?: string;
        };
    }
    routes?: CaddyRoute[]
    status_code?: number
    strip_path_prefix?: string
    transport?: { protocol?: string }
    upstreams?: { dial: string }[]
    uri?: string