List Notification Configurations

This API returns a list of notification configurations, each defining how a specific event is delivered and its associated settings.

Endpoint Details

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

---

Request Headers

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

---

Response

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

Response

{
    "items": [
        {
            "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
            ],
            "configurable": true,
            "is_active": true,
            "repeated": true,
            "interval": 5,
            "interval_type": "hours",
            "start_hour": 1,
            "start_minute": 10,
            "end_interval": 10,
            "end_interval_type": "hours",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": 1784282052,
            "updated_at": 1784621907
        },
        {
            "id": "9c31eb15-8af7-4488-828c-730e78dd07b3",
            "category": 3,
            "category_id": "c3d4e5f6-a7b8-4c5d-0e1f-2a3b4c5d6e7f",
            "event": "Backup started",
            "severity": 4,
            "description": "Backup process started",
            "type": 2,
            "channels": [
                2
            ],
            "configurable": true,
            "is_active": true,
            "interval": 1,
            "interval_type": "days",
            "end_interval": 24,
            "end_interval_type": "hours",
            "created_at": 1784282052,
            "updated_at": 1784282052
        },
        {
            "id": "31b7c06a-3ee0-4496-9843-cf80b9d5570e",
            "category": 3,
            "category_id": "c3d4e5f6-a7b8-4c5d-0e1f-2a3b4c5d6e7f",
            "event": "Manual restore initiated",
            "severity": 2,
            "description": "Manual restore initiated by admin",
            "type": 1,
            "channels": [
                1
            ],
            "is_active": true,
            "interval": 1,
            "interval_type": "days",
            "end_interval": 24,
            "end_interval_type": "hours",
            "created_at": 1784282052,
            "updated_at": 1784282052
        },
        {
            "id": "61424718-9e05-4e19-ac1e-638e96d1369a",
            "category": 3,
            "category_id": "c3d4e5f6-a7b8-4c5d-0e1f-2a3b4c5d6e7f",
            "event": "Restore initiated (scheduled)",
            "severity": 3,
            "description": "Scheduled restore initiated",
            "type": 2,
            "channels": [
                2
            ],
            "configurable": true,
            "is_active": true,
            "interval": 1,
            "interval_type": "days",
            "end_interval": 24,
            "end_interval_type": "hours",
            "created_at": 1784282052,
            "updated_at": 1784282052
        }
    ],
    "pagination": {
        "total": 4,
        "page": 1,
        "page_size": 20,
        "last_page": 1
    }
}

---

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
repeated	Boolean	Indicates whether the notification is repeated
interval	Integer	Interval value for repeated notifications
interval_type	String	Unit of the interval value
start_hour	Integer	Hour of day when the repeated notification starts
start_minute	Integer	Minute of the hour when the repeated notification starts
end_interval	Integer	End interval value for repeated notifications
end_interval_type	String	Unit of the end interval value
updated_by	UUID	Identifier of the user who last updated the configuration
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
total	Integer	Total number of notification configurations available
page	Integer	Current page number
page_size	Integer	Number of records returned per page
last_page	Integer	Total number of available pages

---

info

• A valid Bearer Token is required to access this endpoint.
• The configurable field indicates whether a configuration's settings can be changed. It may not be present for configurations that cannot be modified.
• The repeated, start_hour, start_minute, and updated_by fields are only present for configurations that have been updated with a repeat schedule.
• 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.