featherbit UI
    Preparing search index...

    Interface StoreConfig

    A named shared store: a redis/valkey connection referenced by plugin config (store / session_store).

    Mirrors src/config/gateway.rs::StoreConfig (YAML key type ↔ store_type); served raw — ${ENV} placeholders are never resolved by the Admin API.

    interface StoreConfig {
        connect_budget_ms: number;
        connect_timeout_ms: number;
        description?: string;
        key_prefix: string;
        name: string;
        password?: string;
        tls?: StoreTlsConfig;
        topology?: string;
        type: string;
        url: string;
        urls?: string[];
    }
    Index
    connect_budget_ms connect_timeout_ms description? key_prefix name password? tls? topology? type url urls?
    connect_budget_ms: number
    connect_timeout_ms: number

    Connect/response timeout in milliseconds (server default 2000).

    description?: string

    Optional human-readable description shown in the sidebar.

    key_prefix: string

    Namespace prefix for every key this store writes (server default fb).

    name: string

    Unique name, referenced by plugin config.

    password?: string

    Optional password; overrides any password embedded in the URL.

    tls?: StoreTlsConfig

    Optional TLS options for rediss://.

    topology?: string

    Reserved for HA topologies; v1 accepts only standalone.

    type: string

    Backend type: redis or valkey (aliases for the same RESP backend).

    url: string

    Connection URL (redis:// or rediss://); may hold ${ENV} placeholders.

    urls?: string[]

    Reserved for HA topologies; rejected in v1.

    Settings
    Member Visibility

    On This Page
    Properties