List notification delivery routes

GET

/api/admin/notifications/delivery-routes

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/notifications/delivery-routes \
  --header 'Authorization: Bearer <token>'

List notification delivery route rules visible to the current admin scope.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

limit

integer format: int64

>= 1 <= 500

Maximum number of delivery routes to return.

Responses

200

Notification delivery routes.

Media type application/json

object

items

required

Array<object>

object

id

string

name

string

scope_type

string

scope_id

string

provider

string

destination_id

string

categories_json

Any of:

string

string

null

null

severities_json

Any of:

string

string

null

null

min_severity

Any of:

string

string

null

null

enabled

integer format: int64

failure_policy

string

max_attempts

integer format: int64

retry_after_seconds

integer format: int64

suppression_key

Any of:

string

string

null

null

created_by

string

updated_by

string

created_at

integer format: int64

updated_at

integer format: int64

version

integer format: int64

Example

{
  "items": [
    {
      "id": "indr_123",
      "name": "Critical email",
      "scope_type": "tenant",
      "scope_id": "tenant_123",
      "provider": "email",
      "destination_id": "sd_123",
      "categories_json": "[\"logging_delivery_failure\"]",
      "severities_json": "[\"high\",\"critical\"]",
      "min_severity": "high",
      "enabled": 1,
      "failure_policy": "retry_until_dead_letter",
      "max_attempts": 5,
      "retry_after_seconds": 300,
      "suppression_key": "logging-delivery",
      "created_by": "admin_123",
      "updated_by": "admin_123",
      "created_at": 1770000000000,
      "updated_at": 1770000000000,
      "version": 1
    }
  ]
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}