Skip to content
Authrim

Create a notification delivery route

POST
/api/admin/notifications/delivery-routes
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/notifications/delivery-routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Critical email", "scope_type": "tenant", "scope_id": "tenant_123", "provider": "email", "destination_id": "sd_123", "categories": [ "storage_registry_health" ], "severities": [ "high", "critical" ], "min_severity": "high", "enabled": true, "failure_policy": "retry_until_dead_letter", "max_attempts": 5, "retry_after_seconds": 300 }'

Create a notification delivery route for selected categories, severities, provider, and destination.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Create an internal notification delivery route.

Media type application/json
object
name
required
string
scope_type
required
string
scope_id
string
provider
required
string
destination_id
string
categories
Array<string>
severities
Array<string>
min_severity
string
enabled
boolean
failure_policy
string
max_attempts
integer format: int64
retry_after_seconds
integer format: int64
suppression_key
string
Example 
{
  "name": "Critical email",
  "scope_type": "tenant",
  "scope_id": "tenant_123",
  "provider": "email",
  "destination_id": "sd_123",
  "categories": [
    "storage_registry_health"
  ],
  "severities": [
    "high",
    "critical"
  ],
  "min_severity": "high",
  "enabled": true,
  "failure_policy": "retry_until_dead_letter",
  "max_attempts": 5,
  "retry_after_seconds": 300
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful JSON response.

Media type application/json
object
item
required
object
key
additional properties
audit_id
One of:
string
version
integer
key
additional properties
Example 
{
  "item": {
    "id": "pol_123",
    "tenant_id": "tenant_123",
    "log_type": "security",
    "plane": "control",
    "destination_id": "dest_123",
    "fallback_policy_id": null,
    "enabled": 1,
    "managed_by": "platform",
    "change_protection": "confirm",
    "approval_policy_id": null,
    "policy_hash": "sha256:abc123",
    "version": 1,
    "created_at": 1770000000000,
    "updated_at": 1770000000000
  },
  "audit_id": "audit_123",
  "version": 1
}

default

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