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…
Platform availability
Available on 3 of 10 platforms
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
81/100 Excellent
- Maintained
- 100last commit 24 days ago
- Popular
- 631,337 GitHub stars
- Easy to install
- 553 install platforms, install notes, Docker image
- Light to run
- 801 GB minimum RAM, runs on ARM
- Security check
- 95no serious findings, CI, tests
Availability: platform listings confirmed today, links checked 8 days ago
- GitHub stars
- 1,337
- Open issues
- 11
- Last commit
- 2026-10-28
- Latest release
- v2.0.2
- License
- MIT
- Activity
- steady
Checked 19 days ago - source: GitHub (caronc/apprise-api)
Resources & Compatibility
Minimum requirements: 1 GB RAM, 1 CPU core(s), 10 GB disk. ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Install the Apprise package first Install the Apprise Python package for your system (for example, pip install apprise) before starting the Apprise API web service. Without it, the web service has no library available to send alerts to email, chat, or other services. source
- List your notification URLs in the config file Add each destination you want to receive alerts to, such as email or chat, as a notification URL in the Apprise config file, and use # for comments. Keep that file private because these URLs often include access keys, and without valid URLs Apprise has nowhere to send messages. source
- Async APIs need nest-asyncio installed If your Apprise API runs inside Python code that already uses asyncio (Python’s built-in async task system), install nest-asyncio before starting it. Without it, Apprise can error when it tries to send notifications while that background task system is already running. source
Fetched 54 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
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.
Answers sourced from appriseit.com, github.com, github.com, github.com, www.reddit.com, www.reddit.com
Community
- r/selfhosted on Reddit: Apprise - A lightweight all-in-one notification ... (reddit)
- Does anyone have a good tutorial to get started using apprise ... - Reddit (reddit)
- Apprise v1.0.0 (Official Release) : r/selfhosted - Reddit (reddit)
- Appraise API App? - Apps and Virtualization - TrueNAS Community Forums (forum)
Collected 53 days ago - public community threads