Apprise Logo

Apprise API

Management for Config ID: ba6f72889db639517f0fde3c7f9e4f1b6e20fb15136373e1ece6d1c134e2ba12

Getting Started
  1. Here is where you can store your Apprise configuration associated with the key ba6f72889db639517f0fde3c7f9e4f1b6e20fb15136373e1ece6d1c134e2ba12. 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://178.254.32.78:8000/cfg/ba6f72889db639517f0fde3c7f9e4f1b6e20fb15136373e1ece6d1c134e2ba12
  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://178.254.32.78:8000/ba6f72889db639517f0fde3c7f9e4f1b6e20fb15136373e1ece6d1c134e2ba12/?tags=all
Send one or more attachments like this: 
apprise --body="Test Message" \

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

Loaded Configuration

Define your configuration below:

You can send a notification using the loaded configuration: