Apprise API

v1.5.0

APPRISE LIBRARY v1.11.0
API HEALTH

Apprise Health Check Failed

The following disk access errors have been detected with your Apprise instance:

Configuration Write Failure
Apprise can not write new configuration information to the directory:
```
/config
```
Note: If this is the expected behavior, pre-set the environment variable shown below and reload your Apprise instance.
```
APPRISE_CONFIG_LOCK=yes
```
Attachment Temporary Storage Write Failure
Apprise can not circulate attachments (if provided) due to not having write access to the directory:
```
/attachments
```
Note: If this is the expected behavior, pre-set the environment variable shown below and reload your Apprise instance.
```
APPRISE_ATTACH_SIZE=0
```

More Details

Under most circumstances, the issue(s) identified here are usually related to permission issues. Make sure you set the correct PUID and GUID to reflect the permissions you wish Apprise to utilize when it is reading and writing its files. In addition to this, you may need to make sure the permissions are set correctly on the directories you mapped them too.

The issue(s) identified here can also be associated with SELinux. You may wish to rule out SELinux by temporarily disabling it with:

sudo setenforce 0

You can always re-enable it with:

sudo setenforce 1

Config ID f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

Overview
Configuration
Review
Notifications

Getting Started

Verify your Apprise API Status:
The following is your Apprise Configuration ID:
```
f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd
```
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:
```
https://apprise.pchu.win/cfg/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd
```
Use the Configuration section to prepare and save your Apprise configuration.

You can always refer to the Apprise URL Builder if you're having troubles assembling your URL(s).
Use the Review section to review what was parsed/detected from your defined configuration.
Use the Notifications section to test out your saved configuration.

: The number also provided in the Notifications tab identifies how many notifications will be sent (based on tags/configuration provided) when using this section.

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" \

                   apprises://apprise.pchu.win/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd/?tags=all

Send one or more attachments like this:

apprise --body="Test Message" \

                   apprises://apprise.pchu.win/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd/?tags=all \

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

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

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=https://apprise.pchu.win/cfg/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

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

include https://apprise.pchu.win/cfg/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

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" \

                       https://apprise.pchu.win/notify/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

When sending attachments, curl requires all local files be prefixed with @. You can an add attachment like this:

curl -X POST \

                  -F "tags=all" \

                  -F "body=Test Message" \

                  -F attach=@Screenshot-1.png \

                  https://apprise.pchu.win/notify/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

When sending more than one attachment, you must uniquely assign each attachment to a new ID. The example below leverages attach1 and attach2:

curl -X POST \

                  -F "tags=all" \

                  -F "body=Test Message" \

                  -F attach1=@Screenshot-1.png \

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

                  https://apprise.pchu.win/notify/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

Sends a notification to our endpoints with an attachment and no body specified:

curl -X POST \

                   -F "tag=all" \ 

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

                   https://apprise.pchu.win/notify/f6b562e9fcae6cdfdbf67cfeeaeca60e5e9c19989ca9e46b03ea731d8dd151bd

Configuration

Define your configuration below:

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

Loaded Configuration

0 notification(s) selected for sending

Review the parsed destinations below before sending.
Select a tag (🏷️) on any entry to include it in Notifications.
Use to run a quick test and inspect the full debug output for that entry.
Need more destinations? Add or update them in Configuration.

Notifications

You can send a notification using the loaded configuration:

No Notification Targets Selected

Choose one or more tags from the Tags dropdown, select target entries from the Review section, or add more entries in the Configuration section.