Skip to main content
Operations for managing Stash configuration and settings. Bases: StashClientProtocol Mixin for configuration methods.

Functions

configure_general

Configure general Stash settings. Parameters: Returns: Examples: Configure database path:
Using the input type:

configure_interface

Configure Stash interface settings. Parameters: Returns: Examples: Configure interface options:
Using the input type:

configure_dlna

Configure DLNA server settings. Parameters: Returns: Examples: Enable DLNA server:
Using the input type:

configure_defaults

Configure default metadata operation settings. Parameters: Returns: Examples: Configure default delete behavior:
Using the input type:

configure_ui

Configure UI settings. Parameters: Returns: Examples: Update UI configuration:
Replace entire UI config:

configure_ui_setting

Configure a single UI setting. Parameters: Returns: Examples: Update a single UI setting:
Update multiple settings one at a time:

generate_api_key

Generate a new API key. Parameters: Returns: Examples: Generate new API key:
Clear and generate new key:

find_saved_filter

Find a saved filter by ID. Parameters: Returns:

find_saved_filters

Find all saved filters, optionally filtered by mode. Parameters: Returns:

configure_scraping

Configure scraping settings. Parameters: Returns:

validate_stashbox_credentials

Validate StashBox credentials. Parameters: Returns:

enable_dlna

Enable DLNA server. Parameters: Returns:

disable_dlna

Disable DLNA server. Parameters: Returns:

add_temp_dlna_ip

Add temporary DLNA IP whitelist. Parameters: Returns:

remove_temp_dlna_ip

Remove temporary DLNA IP from whitelist. Parameters: Returns:

get_configuration

Get complete Stash configuration. Returns: Raises: Examples: Get full configuration:
Check specific settings:
Inspect plugin configurations: