Portainer for Home Assistant (built-in integration)

About

Portainer is a built-in integration that connects Home Assistant to a Portainer instance to monitor and control Docker containers. It connects locally using an API access token, the instance URL with its port, and an option to turn off SSL certificate verification for self-signed certificates. It adds binary sensors, sensors, switches, buttons, events and update entities for containers, stacks and endpoints. Buttons can pause, resume, restart, kill or recreate a container, update a stack, and prune unused images or volumes. Recreating a container is more disruptive than a restart, since the container is stopped, removed and rebuilt with the same configuration. New devices appear automatically, removed ones are cleaned up, and connection settings can be changed without removing the integration.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Adds new devices New devices show up without setting it up again.
Cleans up devices Devices that are gone are removed by themselves.
Change settings later Its connection settings can change without removing it.
Platinum quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Switches
Sensors

Setting it up

It is added under Settings, Devices and services, with Add integration.

Connect

API tokenThe API access token for authenticating with Portainer
URLThe URL, including the port, of your Portainer instance
Verify SSL certificateWhether to verify SSL certificates. Disable only if you have a self-signed certificate

Also asked when changing the connection.

Sign in again

API tokenThe new API access token for authenticating with Portainer

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsOut of memory, Status
ButtonsPrune unused images, Kill container, Pause container, Recreate container, Restart container, Resume container, Update stack, Prune unused volumes
EventsDocker event
SensorsAPI version, Architecture, Container disk usage reclaimable, Container disk usage total size, Health, Restart count, Started, State, Container count, Containers paused, Containers running, Containers stopped, and 21 more
SwitchesContainer, Stack
UpdatesImage update available

Actions

Prune unused imagesPrunes unused images on a Portainer endpoint.Fields: Dangling, Endpoint, Until
Recreate containerRecreates a container on a Portainer endpoint. This is more disruptive than a restart as the container will be stopped, removed, and then re-created with the same configuration. Use with caution.Fields: Container, Pull image, Timeout