Skip to content

Add Portainer docs #39268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: next
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions source/_integrations/portainer.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Portainer
description: Instructions on how to integrate Portainer with Home Assistant.
ha_category:
- Binary sensor
ha_release: 2025.7
ha_iot_class: Cloud Polling
ha_codeowners:
- '@erwindouna'
ha_domain: portainer
ha_config_flow: true
ha_platforms:
- binary_sensor
ha_integration_type: integration
---

The Portainer {% term integration %} is used as an interface to the [Portainer API](https://docs.portainer.io/api).
Portainer is a lightweight management UI that allows you to easily manage your Docker containers, images, networks, and volumes. It works on every Docker host or Swarm cluster.

The Portainer API provides a way to manage Docker containers, images, networks, and volumes. It allows you to interact programmatically with your Docker host or Swarm cluster.

## Prerequisites

Before you can configure Portainer within Home Assistant, you need a few things:

- have Portainer installed and a user with administrator rights on Portainer.
- an Access Token.

Create a Portainer Access Token by following these steps:

1. Log in to your Portainer instance.
2. To create an access token, follow the steps in the [Portainer documentation](https://docs.portainer.io/api/access).
3. Copy the generated Access Token and store it somewhere safe, you will need it in the next steps.

{% include integrations/config_flow.md %}

## Supported functionality

{% note %}
This integration is currently being actively developed and tested. More platforms and features will be added in.
{% endnote %}

There is currently support for the following device types within Home Assistant:

- Binary sensor - for monitoring the status of Portainer services.

## Removing the integration

This integration follows standard integration removal.

{% include integrations/remove_device_service.md %}

After removing the integration, consider deleting the Portainer access token.