Apprise API
| Schemes | apprise://, apprises:// |
| Cargo feature | service-appriseapi |
| Service | https://github.com/caronc/apprise-api |
| Body formats | text, html, markdown (first is the default) |
| Attachments | yes |
| Title length | 250 characters |
| Body length | 32,768 characters |
| Body lines | unlimited |
| Request throttle | none |
| Vendor URLs accepted | yes |
URL formats
{schema}://{host}/{token}
{schema}://{host}:{port}/{token}
{schema}://:{password}@{host}/{token}
{schema}://:{password}@{host}:{port}/{token}
{schema}://{user}@{host}/{token}
{schema}://{user}@{host}:{port}/{token}
{schema}://{user}:{password}@{host}/{token}
{schema}://{user}:{password}@{host}:{port}/{token}
{schema} is one of apprise://, apprises://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{host} | Hostname | string | yes | ||
{password} | Password | string | no | secret | |
{port} | Port | int, 1 to 65535 | no | ||
{token} | Token | string | yes | secret; must match ^[A-Z0-9_-]{1,128}$ | |
{user} | Username | string | no |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
method | Query Method | choice | form | one of form, json |
tags | Tags | string | ||
to | Token | string | sets {token} | |
version | API Version | choice | 2 | also v; one of 1, 2 |
Prefixed parameters:
+name=value: HTTP Header
The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.
Examples
Accepted URLs (tokens are fake):
apprise://localhost/mytoken0/
apprise://user@localhost/mytoken1/
apprise://localhost/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
apprises://localhost/cccccccccccccccccccccccccccccccc
http://example.com/notify/dddddddddddddddddddddddddddddddd
https://example.com/path/notify/dddddddddddddddddddddddddddddddd
apprise://localhost/mytoken1/?v=1
apprise://localhost/tok/?tags=a,b
Rejected URLs:
apprise://
apprise://:@/
apprise://localhost
apprise://localhost/!
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'apprise://localhost/mytoken0/'
Notes
Apprise API relay (apprise://, apprises://): hands the notification to an Apprise API server, which delivers it to its configured services.