The Apprise API
Apprise allows you to send a notification to almost all of the most popular notification services available to us today such as: Telegram, Discord, Slack, Amazon SNS, Gotify, etc. This API provides a simple gateway to directly access it via an HTTP interface.
- chevron_rightThis project was designed to be incredibly light weight.
- chevron_rightConfiguration can be persistently stored for retrieval.
Stateless Endpoints
Those who wish to treat this API as nothing but a sidecar and/or microservice to their project only need to use the following URL.
| URL | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
/notify/
|
Used to notify one one or more specified Apprise URLs. See the Apprise URL Builder if you need help
constructing your URL(s).
|
Persistent Store Endpoints
Those wishing to use the persistent store may do so. This section is a set it and forget it type deal. Set your configuration once and just trigger notifications later on demand with light-weight API calls.
All endpoints that expect posted data can be received in either JSON or in it's standard
encoding.
You must pass along the Content-Type as application/json in order for it to be
interpreted properly.
| URL | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
/add/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac
|
Used to add a new Apprise configuration or a set of URLs and associates them with configuration
identified with the id of b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac. See the Apprise URL Builder if you need help
constructing your URLs.
|
||||||||||
/del/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac
|
There are no arguments required. If configuration id of b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac exists and has data associated with
it, it will be removed.
|
||||||||||
/get/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac
|
This feature can be used by Apprise itself. It provides a means of remotely fetching it's
the configuration associated with the configuration identified through the id of b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac.
|
||||||||||
/cfg/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac
|
This is an alias of /get/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac defined above. It provides a means of remotely fetching it's
the configuration associated with the configuration identified through the id of b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac.
|
||||||||||
/notify/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac
|
Notifies the URLs associated with configuration identified by the id of b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac.
|
Endpoint Notes
The Configuration ID (b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac) you plan to associate your configuration with:
-
Cannot have spaces or special characters. A dash (
-) and underscore (_) are the only exceptions to this rule. - Must start with at least two alphanumeric characters.
- Cannot exceed 64 characters in total length.
Service and URL Endpoints
Your own programs can look up what each service needs and check Apprise URLs without sending anything. The Available Services page is built on these.
| URL | Description |
|---|---|
/details/
|
Lists every service this server supports and the fields each of its URLs is built from.
|
/resolve/b31e7ccdb7e6b058d9545516450ec26d34cdf2c1df132a992142d30557357aac
|
Takes Apprise URLs apart into their fields, or puts fields back together into a URL. Nothing is contacted; the URLs are only read.
More details on the JSON format can be found here.
|