Detail Notification Configuration by ID

This API returns detailed information about a specific notification configuration identified by ID.

Endpoint Details

URL	/v1/notifications/config/id
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To retrieve the details of a specific notification configuration, use the following request format:

/v1/notifications/config/a0871269-0e05-44e6-ab70-1a8940418e4f

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the notification configuration

---

Response

Here is an example of a response when viewing data details:

Response

{
    "id": "a0871269-0e05-44e6-ab70-1a8940418e4f",
    "category": 3,
    "category_id": "c3d4e5f6-a7b8-4c5d-0e1f-2a3b4c5d6e7f",
    "event": "Backup paused",
    "severity": 3,
    "description": "Backup paused due to maintenance or error",
    "type": 2,
    "channels": [
        1,
        2
    ],
    "configurable": true,
    "is_active": true,
    "interval": 1,
    "interval_type": "days",
    "end_interval": 24,
    "end_interval_type": "hours",
    "created_at": 1784282052,
    "updated_at": 1784282052
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the notification configuration
category	Integer	Category code of the notification
category_id	UUID	Identifier of the notification category
event	String	Name of the event that triggers the notification
severity	Integer	Severity code assigned to the event
description	String	Description of the event
type	Integer	Type code of the notification
channels	Array	List of channel codes used to deliver the notification
configurable	Boolean	Indicates whether the configuration can be modified
is_active	Boolean	Indicates whether the configuration is active
interval	Integer	Interval value for repeated notifications
interval_type	String	Unit of the interval value
end_interval	Integer	End interval value for repeated notifications
end_interval_type	String	Unit of the end interval value
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing notification configuration.
• The configurable field indicates whether the configuration's settings can be changed.
• The category field uses the following codes:
  • 1 = Security & Access Control
  • 2 = Key Lifecycle
  • 3 = Backup & Recovery
  • 4 = System Health & Performance
  • 5 = Compliance & Audit Trail
  • 6 = User & Role Management
  • 7 = Network & Connectivity
  • 8 = Integration & API Activity
  • 9 = Operational & Maintenance
• The severity field uses the following codes:
  • 1 = Critical
  • 2 = High
  • 3 = Medium
  • 4 = Low
• The channels array uses the following codes:
  • 1 = Email
  • 2 = Dashboard
• Unix timestamp fields can be converted to a human-readable date and time format as needed.