List notification rules

GET

/notifications/rules

curl --request GET \
  --url https://sylve.lan:8181/api/notifications/rules \
  --header 'Authorization: <Authorization>'

List notification rule templates and concrete target rules, including inactive retained targets

Authorizations

• BearerAuth

Responses

200

Success

Media typeapplication/json

object

data

object

rules

Array<object>

object

active

boolean

config

string

discordEnabled

boolean

emailEnabled

boolean

id

integer

kind

string

ntfyEnabled

boolean

pushoverEnabled

boolean

targetKey

string

targetLabel

string

templateKey

string

templateLabel

string

uiEnabled

boolean

templates

Array<object>

object

defaultConfig

string

description

string

key

string

label

string

targetType

string

targets

Array<object>

object

key

string

label

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "rules": [
      {
        "active": true,
        "config": "example",
        "discordEnabled": true,
        "emailEnabled": true,
        "id": 1,
        "kind": "example",
        "ntfyEnabled": true,
        "pushoverEnabled": true,
        "targetKey": "example",
        "targetLabel": "example",
        "templateKey": "example",
        "templateLabel": "example",
        "uiEnabled": true
      }
    ],
    "templates": [
      {
        "defaultConfig": "example",
        "description": "example",
        "key": "example",
        "label": "example",
        "targetType": "example",
        "targets": [
          {
            "key": "example",
            "label": "example"
          }
        ]
      }
    ]
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}