Apprise API

The Apprise API turns Apprise into a service. You run it once, point your systems at it, and they can all send notifications with simple HTTP(S) requests without installing Python, without the CLI, and without knowing anything about the services behind it.

It is the middle box in the picture below: everything on the left hands it a message, and it takes care of delivering to everything on the right.

Use Cases

• One endpoint for everything. Your scripts, containers, and applications all post to the same place instead of each carrying their own credentials.
• Keep your URLs in one spot. Save a set of destinations under a key such as my-alerts, then send to that key. Change who gets notified without touching anything that calls you.
• Or store nothing at all. Send the destination URLs with each request instead, which suits short-lived containers and sidecars. One server does both.
• No Python required. Anything that can make an HTTP request can send a notification, including tools and appliances that have no scripting at all.
• A web interface included. Manage saved configurations and send test notifications from your browser. It follows your browser language, and you can turn it off with APPRISE_API_ONLY=yes.
• Runs anywhere. A small container that is at home under Docker, Docker Compose, or Kubernetes.

Add your phone to the picture

Apprise Mobile is the official Android companion for a server you already run. Scan a QR code from the web interface to connect, then send notifications, share a photo, and check what was delivered, all from your phone.

Get It on Google Play

Getting Started

1. Deploy it. Start the container with Docker or Kubernetes.
2. Add your destinations. Use the web interface to save your notification URLs and give them a key.
3. Send. Point anything that speaks HTTP at your server and the message goes out.

Deploy the server · See what it can do · Browse the endpoints