@jambonz/sdk
    Preparing search index...

    Interface EnvVarDef

    Definition of a single application environment variable.

    interface EnvVarDef {
        type: "string" | "number" | "boolean";
        description: string;
        required?: boolean;
        default?: string | number | boolean;
        enum?: (string | number | boolean)[];
        obscure?: boolean;
        uiHint?: "input" | "textarea" | "filepicker";
        jambonzResource?: "carriers";
    }
    Index

    Properties

    type description required? default? enum? obscure? uiHint? jambonzResource?

    Properties

    type: "string" | "number" | "boolean"

    Value type.

    description: string

    Human-readable description shown in the jambonz portal.

    required?: boolean

    Whether the user must provide a value.

    default?: string | number | boolean

    Default value pre-filled in the portal UI.

    enum?: (string | number | boolean)[]

    Allowed values — renders as a dropdown in the portal.

    obscure?: boolean

    Mask the value in the portal UI (for secrets/API keys).

    uiHint?: "input" | "textarea" | "filepicker"

    UI rendering hint: 'input' (default), 'textarea' (multi-line), or 'filepicker' (file upload).

    jambonzResource?: "carriers"

    Populate a dropdown from jambonz account data. Currently supports 'carriers'.

    Settings

    Member Visibility

    On This Page

    Properties