Skip to content
SYLVE

Update a notification rule

PUT
/notifications/rules/{id}
curl --request PUT \
  --url https://sylve.lan:8181/api/notifications/rules/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": "example", "discordEnabled": true, "emailEnabled": true, "ntfyEnabled": true, "pushoverEnabled": true, "uiEnabled": true }'

Update channel toggles and optional template-specific configuration for one notification rule

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer
>= 1

Notification rule ID

Request Body

Section titled “Request Body”

Notification rule update

Media typeapplication/json
object
config
string
discordEnabled
boolean
emailEnabled
boolean
ntfyEnabled
boolean
pushoverEnabled
boolean
uiEnabled
boolean
Examplegenerated
{
  "config": "example",
  "discordEnabled": true,
  "emailEnabled": true,
  "ntfyEnabled": true,
  "pushoverEnabled": true,
  "uiEnabled": true
}

Responses

Section titled “Responses”

200

Section titled “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
Examplegenerated
{
  "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"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}