{% 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 "Stateless Endpoints" %}

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

{% trans "URL" %} {% trans "Description" %}
{{BASE_URL}}/notify/ {% blocktrans %}Used to notify one one or more specified Apprise URLs. See the Apprise Wiki if you need help constructing your URL(s).{% 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 %}
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. info{% trans "info" %} - {% blocktrans %}this is the default option if a type isn't specified.{% endblocktrans %}
  2. check_circle{% trans "success" %}
  3. report_problem{% trans "warning" %}
  4. cancel{% trans "failure" %}
  • codeCurl Example
    
								    # {% blocktrans %}Notifies an email address{% endblocktrans %}
    
								    curl -X POST -d '{"urls":"mailto://user:pass@gmail.com","body":"test body","title":"test title"}' \
    
										    -H "Content-Type: application/json" \
    
										    "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/"
                    

    
								    # {% blocktrans %}Notifies an email address with attachments{% endblocktrans %}
    
								    curl -X POST -F 'urls=mailto://user:pass@gmail.com' \
    
                        -F 'title=test title' \
    
                        -F 'body=test body' \
    
                        -F attach1=@/path/to/attachment.doc \
    
                        -F attach2=@Screenshot-2.png \ 
    
										    "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/"
  • codePython Example
    
                    import json
    
                    from urllib.request import Request
    
                    
    
                    payload = {
    
                        'urls': 'mailto://user:pass@gmail.com',
    
                        'title': 'test title',
    
                        'body': 'test body',
    
                    }
    
                    
    # The Request
    
                    response = Request(
    
                        "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/",
    
                        json.dumps(payload).encode('utf-8'),
    
                        {"Content-Type": "application/json"},
    
                        method='POST',
    
                   )
                   
    
                
    
								   # {% blocktrans %}Notifies an email address with attachments{% endblocktrans %}
    
                   import requests

    
                   payload = {
    
                       'urls': 'mailto://user:pass@gmail.com',
    
                       'title': 'test title',
    
                       'body': 'test body',
    
                   }

    
                   with open("my/path/to/attachment.png", 'rb') as fp:
    
                       response = request.post("{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/",
    
                           data=payload,
    
                           files={'attach1':('attachment.png', fp)},
    
                       )
  • codePHP Example
    <?php
    
                  
    
                  // The URL
    
                  $url = '{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/';
    
                  
    
                  //Initiate cURL.
    
                  $ch = curl_init($url);
    
                   
    
                  //The JSON data.
    
                  $jsonData = array(
    
                      'urls' => 'mailto://user:pass@hotmail.com',
    
                      'title' => 'test title',
    
                      'body' => 'test body'
    
                  );
    
                  
    
                  //Encode the array into JSON.
    
                  $jsonDataEncoded = json_encode($jsonData);
    
                  
    
                  //Tell cURL that we want to send a POST request.
    
                  curl_setopt($ch, CURLOPT_POST, 1);
    
                  
    
                  //Attach our encoded JSON string to the POST fields.
    
                  curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);
    
                  
    
                  //Set the content type to application/json
    
                  curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
    
                  
    
                  //Execute the request
    
                  $result = curl_exec($ch);
    
                  
    
                  // Close our handler
    
                  curl_close($ch);
    
                  ?>
                  
    <?php
    
                  // Sending an Attachment using PHP

    
                  // The URL
    
                  $url = '{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/';
    
                  
    
                  //Initiate cURL.
    
                  $ch = curl_init($url);
    
                   
    
                  // Prepare our File attachment
    
                  $path = '/path/to/photo.jpg';
    
                  
    
                  // Acquire our Filename
    
                  $fname = basename($path);
    
                  
    
                  // Get our attachment mime-type (in this case it's 'image/jpg')
    
                  $mimeType = mime_content_type($path);
    
                  
    
                  //The multipart data.
    
                  $data = array(
    
                      'urls' => 'mailto://user:pass@hotmail.com',
    
                      'title' => 'test title',
    
                      'body' => 'test body',
    
                      'attach1' => new CURLFile($path, $mimeType, $fname)
    
                  );
    
                  
    
                  //Tell cURL that we want to send a POST request.
    
                  curl_setopt($ch, CURLOPT_POST, 1);
    
                  
    
                  //Attach our data to the POST fields.
    
                  curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    
                  
    
                  //Execute the request
    
                  $result = curl_exec($ch);
    
                  
    
                  // Close our handler
    
                  curl_close($ch);
    
                  ?>
{% if STATEFUL_MODE != 'disabled' %}

{% trans "Persistent Store Endpoints" %}

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

{% 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" %}
{{BASE_URL}}/add/{{key}} {% blocktrans %}Used to add a new Apprise configuration or a set of URLs and associates them with configuration identified with the id of {{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: {{key}}{% endblocktrans %}
    
								    curl -X POST -d '{"urls":"mailto://user:pass@gmail.com"}' \
    
										    -H "Content-Type: application/json" \
    
										    {{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/add/{{key}}
    
						        # {% blocktrans %}Load a simple TEXT config entry sent to: {{key}}{% endblocktrans %}
    
										curl -X POST -d '{"format":"text","config":"devops=mailto://user:pass@gmail.com"}' \
    
										    -H "Content-Type: application/json" \
    
										    {{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/add/{{key}}/
  • codePython Example
    
                        import json
    
                        from urllib.request import Request
    
                        
    
                        payload = {
    
                            'urls': 'mailto://user:pass@gmail.com',
    
                        }
    
                        
    # The URL if the key was {{key}}
    
                        req = Request(
    
                            "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/add/{{key}}",
    
                            json.dumps(payload).encode('utf-8'),
    
                            {"Content-Type": "application/json"},
    
                            method='POST',
    
                       )
  • codePHP Example
    <?php
    
                        
    
                        // The URL if the key was {{key}}
    
                        $url = '{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/add/{{key}}';
    
                        
    
                        //Initiate cURL.
    
                        $ch = curl_init($url);
    
                         
    
                        //The JSON data.
    
                        $jsonData = array(
    
                            'urls' => 'mailto://user:pass@hotmail.com'
    
                        );
    
                        
    
                        //Encode the array into JSON.
    
                        $jsonDataEncoded = json_encode($jsonData);
    
                        
    
                        //Tell cURL that we want to send a POST request.
    
                        curl_setopt($ch, CURLOPT_POST, 1);
    
                        
    
                        //Attach our encoded JSON string to the POST fields.
    
                        curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);
    
                        
    
                        //Set the content type to application/json
    
                        curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
    
                        
    
                        //Execute the request
    
                        $result = curl_exec($ch);
    
                        
    
                        // Close our handler
    
                        curl_close($ch);
    
                        ?>
{{BASE_URL}}/del/{{key}} {% blocktrans %}There are no arguments required. If configuration id of {{key}} exists and has data associated with it, it will be removed.{% endblocktrans %}
  • codeCurl Example
    
								    # {% blocktrans %}Remove previously loaded configuration associated with the id of {{key}}{% endblocktrans %}
    
								    curl -X POST {{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/del/{{key}}
  • codePython Example
    
                      import json
    
                      from urllib.request import Request
    
                      
    # The request if the key was {{key}}
    
                      req = Request(
    
                          "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/del/{{key}}",
    
                          json.dumps(payload).encode('utf-8'),
    
                          {"Content-Type": "application/json"},
    
                          method='POST',
    
                     )
  • codePHP Example
    <?php
    
                      
    
                      // The URL if the key was {{key}}
    
                      $url = '{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/del/{{key}}';
    
                      
    
                      //Initiate cURL.
    
                      $ch = curl_init($url);
    
                      
    
                      //Tell cURL that we want to send a POST request.
    
                      curl_setopt($ch, CURLOPT_POST, 1);
    
                      
    
                      //Execute the request
    
                      $result = curl_exec($ch);
    
                      
    
                      // Close our handler
    
                      curl_close($ch);
    
                      ?>
{{BASE_URL}}/get/{{key}} {% blocktrans %}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 {{key}}.{% endblocktrans %}
# Use Apprise to retrieve your configuration:

                apprise --body="test message" --config={{ request.scheme }}://{{request.META.HTTP_HOST}}{{BASE_URL}}/get/{{key}}
{{BASE_URL}}/notify/{{key}} {% blocktrans %}Notifies the URLs associated with configuration identified by the id of {{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. info{% trans "info" %} - {% blocktrans %}this is the default option if a type isn't specified.{% endblocktrans %}
  2. check_circle{% trans "success" %}
  3. report_problem{% trans "warning" %}
  4. cancel{% trans "failure" %}
tag {% blocktrans %}Apply tagging logic to the further filter your URLs. This is an optional field.{% endblocktrans %}
  • codeCurl Example
    
                        # {% blocktrans %}Notifies all URLs assigned to the configuration{% endblocktrans %}
    
                        curl -X POST \
    
                            -F "tag=all" \ 
    
                            -F "body=test body" \ 
    
                            -F "title=test title" \ 
    
                            "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/{{key}}"
    
								    # {% blocktrans %}Notifies all URLs assigned the devops tag{% endblocktrans %}
    
								    curl -X POST -d '{"tag":"devops","body":"test body","title":"test title"}' \
    
										    -H "Content-Type: application/json" \
    
										    "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/{{key}}"
  • codePython Example
    Ideally you should leverage the Apprise Library, it will make your life much easier: 
    
                        import apprise
    
                        
    
                        # Create an Apprise Instance
    
                        aobj = apprise.Apprise()
    
                        
    
                        # Add our URL
    
                        aobj.add("apprise{% if secure %}s{%else%}{%endif%}://{{request.META.HTTP_HOST}}{{BASE_URL}}/{{key}}")
    
                        
    
                        # Send our notification:
    
                        aobj.notify("test body", "test title")
    
                        
    
                        # Sending an attachment is just as easy:
    
                        aobj.notify("test body", "test title", attach="/path/to/file")
    The legacy (but more compatible and light weight) way of doing things: 
    
                        import json
    
                        from urllib.request import Request
    
                        
    
                        payload = {
    
                            'tag': 'devops',
    
                            'title': 'test title',
    
                            'body': 'test body',
    
                        }
    
                        
    # The URL if the key was {{key}}
    
                        req = Request(
    
                            "{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/{{key}}",
    
                            json.dumps(payload).encode('utf-8'),
    
                            {"Content-Type": "application/json"},
    
                            method='POST',
    
                       )
  • codePHP Example
    <?php
    
                      
    
                      // The URL if the key was {{key}}
    
                      $url = '{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/{{key}}';
    
                      
    
                      //Initiate cURL.
    
                      $ch = curl_init($url);
    
                       
    
                      //The JSON data.
    
                      $jsonData = array(
    
                          'tag' => 'devops',
    
                          'title' => 'test title',
    
                          'body' => 'test body'
    
                      );
    
                      
    
                      //Encode the array into JSON.
    
                      $jsonDataEncoded = json_encode($jsonData);
    
                      
    
                      //Tell cURL that we want to send a POST request.
    
                      curl_setopt($ch, CURLOPT_POST, 1);
    
                      
    
                      //Attach our encoded JSON string to the POST fields.
    
                      curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);
    
                      
    
                      //Set the content type to application/json
    
                      curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
    
                      
    
                      //Execute the request
    
                      $result = curl_exec($ch);
    
                      
    
                      // Close our handler
    
                      curl_close($ch);
    
                      ?>
                  
    <?php
    
                  // Sending an Attachment using PHP

    
                  // The URL
    
                  $url = '{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/{{key}}';
    
                  
    
                  //Initiate cURL.
    
                  $ch = curl_init($url);
    
                   
    
                  // Prepare our File attachment
    
                  $path = '/path/to/photo.jpg';
    
                  
    
                  // Acquire our Filename
    
                  $fname = basename($path);
    
                  
    
                  // Get our attachment mime-type (in this case it's 'image/jpg')
    
                  $mimeType = mime_content_type($path);
    
                  
    
                  //The multipart data.
    
                  $data = array(
    
                      'urls' => 'mailto://user:pass@hotmail.com',
    
                      'title' => 'test title',
    
                      'body' => 'test body',
    
                      'attach1' => new CURLFile($path, $mimeType, $fname)
    
                  );
    
                  
    
                  //Tell cURL that we want to send a POST request.
    
                  curl_setopt($ch, CURLOPT_POST, 1);
    
                  
    
                  //Attach our data to the POST fields.
    
                  curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    
                  
    
                  //Execute the request
    
                  $result = curl_exec($ch);
    
                  
    
                  // Close our handler
    
                  curl_close($ch);
    
                  ?>

{% trans "Endpoint Notes" %}

The Configuration ID ({{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.

{% else %}

{% trans "Persistent Store Endpoints" %}

{% blocktrans %}The administrator of this system has disabled persistent storage.{% endblocktrans %}

{% endif %} {% endblock %}