Create Apprise instance
curl --request POST \
--url http://localhost:8080/api/v1/apprise \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"tags": [
"<string>"
],
"username": "<string>",
"password": "<string>",
"timeout": 60,
"verify_ssl": true,
"is_active": true
}
'import requests
url = "http://localhost:8080/api/v1/apprise"
payload = {
"name": "<string>",
"url": "<string>",
"tags": ["<string>"],
"username": "<string>",
"password": "<string>",
"timeout": 60,
"verify_ssl": True,
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
tags: ['<string>'],
username: '<string>',
password: '<string>',
timeout: 60,
verify_ssl: true,
is_active: true
})
};
fetch('http://localhost:8080/api/v1/apprise', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/apprise",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'tags' => [
'<string>'
],
'username' => '<string>',
'password' => '<string>',
'timeout' => 60,
'verify_ssl' => true,
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/apprise"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"timeout\": 60,\n \"verify_ssl\": true,\n \"is_active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/apprise")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"timeout\": 60,\n \"verify_ssl\": true,\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/apprise")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"timeout\": 60,\n \"verify_ssl\": true,\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"url": "<string>",
"tags": [
"<string>"
],
"has_credentials": true,
"username": "<string>",
"timeout": 123,
"verify_ssl": true,
"is_active": true,
"last_fired_at": "<string>",
"created_at": "<string>"
},
"success": true,
"code": 201,
"message": "Apprise instance created successfully."
}{
"success": false,
"code": 401,
"message": "<string>"
}{
"success": false,
"code": 404,
"message": "<string>"
}{
"success": false,
"code": 405,
"message": "<string>"
}{
"success": false,
"code": 422,
"message": "<string>",
"errors": "<string>"
}{
"success": false,
"code": 429,
"message": "<string>"
}{
"success": false,
"code": 500,
"message": "<string>"
}Apprise
Create Apprise instance
Create a new Apprise instance. The password is stored encrypted and is never returned by the API - only its presence is exposed via has_credentials.
POST
/
v1
/
apprise
Create Apprise instance
curl --request POST \
--url http://localhost:8080/api/v1/apprise \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"tags": [
"<string>"
],
"username": "<string>",
"password": "<string>",
"timeout": 60,
"verify_ssl": true,
"is_active": true
}
'import requests
url = "http://localhost:8080/api/v1/apprise"
payload = {
"name": "<string>",
"url": "<string>",
"tags": ["<string>"],
"username": "<string>",
"password": "<string>",
"timeout": 60,
"verify_ssl": True,
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
tags: ['<string>'],
username: '<string>',
password: '<string>',
timeout: 60,
verify_ssl: true,
is_active: true
})
};
fetch('http://localhost:8080/api/v1/apprise', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/apprise",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'tags' => [
'<string>'
],
'username' => '<string>',
'password' => '<string>',
'timeout' => 60,
'verify_ssl' => true,
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/apprise"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"timeout\": 60,\n \"verify_ssl\": true,\n \"is_active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/apprise")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"timeout\": 60,\n \"verify_ssl\": true,\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/apprise")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"timeout\": 60,\n \"verify_ssl\": true,\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"url": "<string>",
"tags": [
"<string>"
],
"has_credentials": true,
"username": "<string>",
"timeout": 123,
"verify_ssl": true,
"is_active": true,
"last_fired_at": "<string>",
"created_at": "<string>"
},
"success": true,
"code": 201,
"message": "Apprise instance created successfully."
}{
"success": false,
"code": 401,
"message": "<string>"
}{
"success": false,
"code": 404,
"message": "<string>"
}{
"success": false,
"code": 405,
"message": "<string>"
}{
"success": false,
"code": 422,
"message": "<string>",
"errors": "<string>"
}{
"success": false,
"code": 429,
"message": "<string>"
}{
"success": false,
"code": 500,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Maximum string length:
100Maximum string length:
500Maximum string length:
100Maximum string length:
255Maximum string length:
500Required range:
1 <= x <= 120Response
AppriseResource
Hide child attributes
Hide child attributes
Allowed value:
"Apprise instance created successfully."⌘I