apprise-api

apprise-api

Docker app from linuxserver's Repository

Overview

Apprise-api(https://github.com/caronc/apprise-api) Takes advantage of Apprise(https://github.com/caronc/apprise) through your network with a user-friendly API.

  • Send notifications to more than 100 services.
  • An incredibly lightweight gateway to Apprise.
  • A production ready micro-service at your disposal.
  • A Simple Website to verify and test your configuration with.

Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.

Runtime arguments

Web UI
http://[IP]:[PORT:8000]
Network
bridge
Shell
bash
Privileged
false

Template configuration

WebUIPorttcp

Port for apprise's interface and API.

Target
8000
Default
8000
AppdataPathrw

Persistent config files

Target
/config
Path: /attachmentsPathrw

Temporary storage for attachments when sent with notifications.

Target
/attachments
APPRISE_ATTACH_SIZEVariable

Max attachment size in Mb. `0` disables attachments. Must have `/attachments` mounted to set to a positive value.

Default
0
PUIDVariable

Container Variable: PUID

Default
99
PGIDVariable

Container Variable: PGID

Default
100
UMASKVariable

Container Variable: UMASK

Default
022

Download Statistics

9,854,767
Total Downloads
177,777
This Month
322,755
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
lscr.io/linuxserver/apprise-api
Last Updated2026-05-04
First Seen2021-03-13

Run apprise-api on Unraid.

apprise-api is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.