Home AssistantHome AssistantContributors

    ↑↓ to moveEnter to openEsc to close

    Config entry

    One set-up instance of an integration, like one Hue bridge, with the configuration Home Assistant stores for it.

    In code
    ConfigEntryasync_setup_entryentry.runtime_data
    In the UI
    Integration entry
    Also
    config entries, entry

    When a user adds an integration in the UI, the config flow creates a config entry. Adding a second bridge creates a second config entry of the same integration.

    A config entry can be disabled, reloaded, and removed on its own. The code that sets it up is async_setup_entry, and anything the integration needs while running, like an API client, goes in entry.runtime_data.

    Related terms

    • Config flowThe steps in the UI that set up an integration and create a config entry.
    • Config subentryA part of a config entry that the user adds and manages on its own, like one AI agent of an integration that connects to an AI service.
    • Options flowThe steps in the UI that change the options of an existing config entry, like how often it polls.
    • IntegrationA package of code that connects Home Assistant to a device, service, or protocol, or adds a feature like automations.
    • Unique IDAn ID that an integration gives an entity or config entry, which never changes, so Home Assistant recognizes it after a restart.