# Apprise API

Apprise API is a lightweight microservice that wraps the Apprise notification library in a network-accessible REST API, letting home-lab users send alerts to over 150 services from any connected device. It is open source and self-hosted, installable on Proxmox, Docker Hub, ZimaOS and Unraid.

Canonical page: https://ourlocalhost.com/app/543/apprise-api

## Description

Apprise API is a lightweight microservice that wraps the Apprise notification library in a network-accessible REST API, letting home-lab users send alerts to over 150 services from any connected device. It includes a built-in web interface for testing and verifying notification configurations, making it a production-ready fit for homelab automation and monitoring stacks.

## Platform availability

Available on 3 of 9 platforms: Unraid, ZimaOS, Proxmox.

## Health score

78/100 (Good), based on 4 of 4 factors.
- Maintained: 100 (last commit 20 days ago)
- Popular: 62 (1,318 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)
- Light to run: 80 (1 GB minimum RAM, runs on ARM)

## Links

- GitHub: https://github.com/caronc/apprise-api
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=apprise-api
- Docker Hub: https://hub.docker.com/r/linuxserver/apprise-api
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/apprise-api
- Unraid: https://ca.unraid.net/apps/apprise-api-0kw4gsv1cpfwhv?q=apprise-api

## Common questions

### Do I need to install anything before starting the Apprise API web service?

Yes, install the Apprise Python package before starting the Apprise API web service. Without it, the service has no library available to send alerts.

### Where do I put notification destinations, and is the config file sensitive?

Add each destination as a notification URL in the Apprise config file, with # for comments. Keep the file private because those URLs often include access keys.

### What reverse proxy setup is recommended before exposing Apprise API to the internet?

Configure a proper secure reverse proxy first. Do not rely on directly exposing ports without that protection.

### Is there an Android app for a self-hosted Apprise API?

Yes, the Android Mobile app can connect to your self-hosted Apprise API server. It can send notifications, manage services, and review delivery results.

### What extra package is needed if Apprise API runs inside an asyncio application?

Install nest-asyncio before starting it. Without that package, Apprise can error when sending notifications while asyncio is already running.

### How should I pick up an Apprise API fix after a release?

Pull the latest Docker image or git repository. This ensures you have the latest Apprise API update that fixed the reported issue.

---
Source: Our Local Host (https://ourlocalhost.com/app/543/apprise-api), the self-hosted and open-source app directory.