Apprise Logo

Apprise API

Management for Config ID: c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684

Getting Started
  1. Here is where you can store your Apprise configuration associated with the key c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684. For some examples on how to build a development environment around this, click here.
  2. 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/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684
  3. Use the settings Configuration section to prepare and save your Apprise configuration.
    • lightbulb_outlineYou can always refer to the Apprise Wiki if you're having troubles assembling your URL(s).
  4. Use the announcement Notifications section to test out your saved configuration.

info Once you have successfully load at least one Apprise URL on the settings 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/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684/?tags=all
Send one or more attachments like this: 
apprise --body="Test Message" \

            apprise://5.161.64.138:8001/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684/?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/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684
You may also create an Apprise configuration file that contains this line somewhere in it: 
include http://5.161.64.138:8001/get/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684
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/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684
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/c1ec05ef81d40bf416efe24945c56fe85d8edfd7273ae97b5e5b8117548a1684

Loaded Configuration

Define your configuration below:

You can send a notification using the loaded configuration: