@backblaze-labs/b2-sdk - v0.4.0
    Preparing search index...

    Interface BackupClientOptionsExperimental

    Configuration options for creating a BackupClient.

    Computer Backup API surface; shape may change as the Backup API docs evolve.

    interface BackupClientOptions {
        additionalAllowedHostSuffixes?: readonly string[];
        allowCustomAuthorizeRealm?: boolean;
        disableSsrfGuard?: boolean;
        followSameOriginRedirects?: boolean;
        masterKey: string;
        masterKeyId: string;
        partnerAccountInfo?: PartnerAccountInfo;
        realm?: string;
        retry?: Partial<RetryOptions>;
        transport?: HttpTransport;
        userAgent?: string;
    }
    Index
    additionalAllowedHostSuffixes?: readonly string[]

    Additional SSRF allow-list host suffixes for the default transport.

    Only consulted when BackupClientOptions.transport is unset; a custom transport is the user's responsibility to harden.

    allowCustomAuthorizeRealm?: boolean

    Allow direct custom authorize realms for tests or private proxies. Leave disabled unless the configured host is trusted with the Master Application Key.

    disableSsrfGuard?: boolean

    Explicitly disable the default SSRF guard after authorize.

    Intended only for controlled simulator/private-proxy tests. Never enable it for URLs derived from untrusted input or production credentials.

    followSameOriginRedirects?: boolean

    Follow same-origin GET/HEAD redirects in the default fetch transport after checking each target with the SSRF guard. POST redirects remain blocked. Defaults to true.

    masterKey: string

    The Master Application Key secret.

    masterKeyId: string

    The Master Application Key ID for the partner administrator account.

    partnerAccountInfo?: PartnerAccountInfo

    Shared Partner authorization state. Defaults to InMemoryPartnerAccountInfo. Pass the same store to BackupClient and Partner clients when both surfaces should reuse one Partner token. Cached authorization whose endpoints fail this client's realm policy is ignored locally until authorize() replaces it; shared stores are not cleared during construction.

    realm?: string

    B2 realm to authenticate against. Accepts a known realm-map key ("production" or "staging") or a direct base URL. Custom HTTPS hosts and loopback IP literal HTTP URLs for local testing are trusted with the Master Application Key during Partner authorize, so never derive realm from untrusted input. Defaults to "production".

    retry?: Partial<RetryOptions>

    Override retry behavior (max retries, backoff, and per-attempt timeout).

    transport?: HttpTransport

    Custom HTTP transport. Defaults to FetchTransport. Wrapped by RetryTransport.

    userAgent?: string

    Custom user-agent string prepended to the SDK default.