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