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/585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb
|
Used to add a new Apprise configuration or a set of URLs and associates them with configuration
identified with the id of 585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb. See the Apprise URL Builder if you need help
constructing your URLs.
|
||||||||||
/del/585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb
|
There are no arguments required. If configuration id of 585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb exists and has data associated with
it, it will be removed.
|
||||||||||
/get/585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb
|
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 585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb.
|
||||||||||
/cfg/585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb
|
This is an alias of /get/585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb defined above. It provides a means of remotely fetching it's
the configuration associated with the configuration identified through the id of 585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb.
|
||||||||||
/notify/585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb
|
Notifies the URLs associated with configuration identified by the id of 585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb.
|
Endpoint Notes
The Configuration ID (585993edfb1fbe0240bd7673651642666735ea29e7844832eb4d678f60bcafeb) 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.