Skip to content
SYLVE

Update a notification transport

PUT
/notifications/transports/{id}
curl --request PUT \
  --url https://sylve.lan:8181/api/notifications/transports/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "discord": { "webhookUrl": "example" }, "email": { "recipients": [ "example" ], "smtpFrom": "example", "smtpHost": "example", "smtpPassword": "example", "smtpPort": 1, "smtpUseTls": true, "smtpUsername": "example" }, "enabled": true, "name": "example", "ntfy": { "authToken": "example", "baseUrl": "example", "topic": "example" }, "pushover": { "apiToken": "example", "userKey": "example" }, "type": "example" }'

Replace the mutable configuration of one notification transport; omitted credentials remain unchanged, and blank required Pushover credentials are preserved

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Notification transport ID

Request Body

Section titled “Request Body”

Notification transport

Media typeapplication/json
object
discord
object
webhookUrl
string
email
object
recipients
Array<string>
smtpFrom
string
smtpHost
string
smtpPassword
string
smtpPort
integer
smtpUseTls
boolean
smtpUsername
string
enabled
boolean
name
string
ntfy
object
authToken
string
baseUrl
string
topic
string
pushover
object
apiToken
string
userKey
string
type
string
Examplegenerated
{
  "discord": {
    "webhookUrl": "example"
  },
  "email": {
    "recipients": [
      "example"
    ],
    "smtpFrom": "example",
    "smtpHost": "example",
    "smtpPassword": "example",
    "smtpPort": 1,
    "smtpUseTls": true,
    "smtpUsername": "example"
  },
  "enabled": true,
  "name": "example",
  "ntfy": {
    "authToken": "example",
    "baseUrl": "example",
    "topic": "example"
  },
  "pushover": {
    "apiToken": "example",
    "userKey": "example"
  },
  "type": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
transports
Array<object>
object
discord
object
webhookUrl
string
email
object
hasPassword
boolean
recipients
Array<string>
smtpFrom
string
smtpHost
string
smtpPort
integer
smtpUseTls
boolean
smtpUsername
string
enabled
boolean
id
integer
name
string
ntfy
object
baseUrl
string
hasAuthToken
boolean
topic
string
pushover
object
hasApiToken
boolean
hasUserKey
boolean
type
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "transports": [
      {
        "discord": {
          "webhookUrl": "example"
        },
        "email": {
          "hasPassword": true,
          "recipients": [
            "example"
          ],
          "smtpFrom": "example",
          "smtpHost": "example",
          "smtpPort": 1,
          "smtpUseTls": true,
          "smtpUsername": "example"
        },
        "enabled": true,
        "id": 1,
        "name": "example",
        "ntfy": {
          "baseUrl": "example",
          "hasAuthToken": true,
          "topic": "example"
        },
        "pushover": {
          "hasApiToken": true,
          "hasUserKey": true
        },
        "type": "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"
}