Apprise API

APPRISE v1.7.2

Configuration Manager

New Configuration

Apprise Details

📣 Notification Services

Configuration Help

Troubleshooting

Using the CLI

Buy Developer A Coffee

Sponsor Apprise Development

Management for Config ID: 60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975

Overview
Configuration
Notifications

Getting Started

Here is where you can store your Apprise configuration associated with the key 60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975. For some examples on how to build a development environment around this, click here.
In the future you can return to this configuration screen at any time by placing the following into your browser: http://5.161.64.138:8001/cfg/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975
Use the Configuration section to prepare and save your Apprise configuration.
- You can always refer to the Apprise Wiki if you're having troubles assembling your URL(s).
Use the Notifications section to test out your saved configuration.

Once you have successfully load at least one Apprise URL on the Configuration section, your loaded entries will display here.

Working Remotely With Your Configuration

Using The Apprise CLI

The following command would cause apprise to directly notify all of your services:

apprise --body="Test Message" \

            apprise://5.161.64.138:8001/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975/?tags=all

Send one or more attachments like this:

apprise --body="Test Message" \

            apprise://5.161.64.138:8001/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975/?tags=all \

            --attach=/path/to/an/attachment.jpeg \ 

            --attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png

The following command would cause apprise to retrieve the configuration loaded and send a test notification to all of your added services:

apprise --body="Test Message" --tag=all \

            --config=http://5.161.64.138:8001/get/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975

You may also create an Apprise configuration file that contains this line somewhere in it:

include http://5.161.64.138:8001/get/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975

By leveraging the include directive, it will automatically be referenced for future calls to the apprise tool. All future calls using Apprise now simplify to:

apprise --body="Test Message" --tag=all

Using CURL

The following command would cause the apprise api to notify all of your services:

curl -X POST \

				    -F "body=Test Message" \

				    -F "tags=all" \

				    http://5.161.64.138:8001/notify/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975

Send one or more attachments like this:

curl -X POST \

				    -F "tags=all" \

				    -F "body=Test Message" \

				    -F attach1=@Screenshot-1.png \

				    -F attach2=@/my/path/to/Apprise.doc \

				    http://5.161.64.138:8001/notify/60e63cd63f00c7429968228d27df8ae9dc585a8f97cb57f6c8c35e60db19d975

Loaded Configuration

An error occurred retrieving the list of loaded Apprise URL(s)