{% extends 'base.html' %} {% load i18n %} {% block body %}

{% trans "The Apprise API" %}

{% blocktrans %} 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.

{% endblocktrans %}

{% trans "Endpoints" %}

{% blocktrans %}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.{% endblocktrans %}

{% trans "URL" %} {% trans "Description" %}
/add/{% trans "KEY" %} {% blocktrans %}Used to add a new Apprise configuration or a set of URLs and associates them with the specified KEY. See the Apprise Wiki if you need help constructing your URLs.{% endblocktrans %}
{% trans "Parameter" %} {% trans "Description" %}
urls {% blocktrans %}Used to define one or more Apprise URL(s). Use a comma and/or space to separate one URL from the next.{% endblocktrans %}
config {% blocktrans %}Provide the contents of either a YAML or TEXT based Apprise configuration.{% endblocktrans %}
format {% blocktrans %}This field is only required if you've specified the config option. It's purpose is to tell the server which of the supported (Apprise) configuration types you are passing. Valid options are:{% endblocktrans %}
  1. {% trans "yaml" %}
  2. {% trans "text" %}
  • {% blocktrans %}You must specify either the urls parameter or the config.{% endblocktrans %}
  • {% blocktrans %}The urls takes priority over the config if both were specified.{% endblocktrans %}
  • {% blocktrans %}The format parameter is only required if the config parameter was also specified.{% endblocktrans %}
  • codecurl example
    # {% blocktrans %}Load a single URL and assign it to the KEY of abc123{% endblocktrans %}
    curl -X POST -d '{"urls":"mailto://user:pass@gmail.com"}' \
        -H "Content-Type: application/json" \
        http://localhost:8000/add/abc123

    #{% blocktrans %}Load a simple TEXT config entry KEY of abc123{% endblocktrans %}
    curl -X POST -d '{"format":"text","config":"devops=mailto://user:pass@gmail.com"}' \
        -H "Content-Type: application/json" \
        http://localhost:8000/add/abc123/
  • codepython example
    Coming Soon
  • codephp example
    Coming Soon
/del/{% trans "KEY" %} {% blocktrans %}There are no arguments required. If the KEY exists and has data associated with it, it will be removed.{% endblocktrans %}
/get/{% trans "KEY" %} {% blocktrans %}This feature can be used by Apprise itself. It provides a means of remotely fetching it's configuration.{% endblocktrans %}

{% trans "As an example:" %}
apprise --body="test message" --config={{ request.scheme }}://{{request.META.HTTP_HOST}}{{ request.path }}{% trans "KEY" %}

  • codecurl example
    # {% blocktrans %}Load a single URL and assign it to the KEY of abc123{% endblocktrans %}
    curl -X POST -H "Content-Type: application/json" \
        http://localhost:8000/get/abc123
  • codepython example
    Coming Soon
  • codephp example
    Coming Soon
/notify/{% trans "KEY" %} {% blocktrans %}Notifies the URLs associated with the specified KEY.{% endblocktrans %}
{% trans "Parameter" %} {% trans "Description" %}
body {% blocktrans %}Defines the message body. This field is required!{% endblocktrans %}
title {% blocktrans %}The title to include in the notification. This is an optional field.{% endblocktrans %}
type {% blocktrans %}This optional field defines the notification type. The possible options are:{% endblocktrans %}
  1. {% trans "info" %} - {% blocktrans %}this is the default option if a type isn't specified.{% endblocktrans %}
  2. {% trans "success" %}
  3. {% trans "warning" %}
  4. {% trans "failure" %}
tags {% blocktrans %}Apply tagging logic to the further filter your URLs. This is an optional field.{% endblocktrans %}
{% trans "Endpoint Notes" %}

The KEY you plan to associate your configuration with:

  1. Can not have spaces and/or special characters in it. Both a dash (-) and underscore (_) are the only exceptions to this rule.
  2. Must start with at least 2 alpha/numeric characters.
  3. Can not exceed 64 characters in total length.

{% endblock %}