List Notification Configuration Categories
This API returns the list of notification configuration categories, including how many events each category contains and how many are active.
Endpoint Details
| URL | /v1/notifications/config/categories |
| 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": [
{
"category_id": "c3d4e5f6-a7b8-4c5d-0e1f-2a3b4c5d6e7f",
"category": "BACKUP_RECOVERY",
"total_event": 12,
"total_active": 12
},
{
"category_id": "e5f6a7b8-c9d0-4e5f-2a3b-4c5d6e7f8a9b",
"category": "COMPLIANCE_AUDIT_TRAIL",
"total_event": 3,
"total_active": 2
},
{
"category_id": "b8c9d0e1-f2a3-4b5c-5d6e-7f8a9b0c1d2e",
"category": "INTEGRATION_API_ACTIVITY",
"total_event": 4,
"total_active": 2
},
{
"category_id": "b2c3d4e5-f6a7-4b5c-9d0e-1f2a3b4c5d6e",
"category": "KEY_LIFECYCLE_MANAGEMENT",
"total_event": 12,
"total_active": 6
},
{
"category_id": "a7b8c9d0-e1f2-4a5b-4c5d-6e7f8a9b0c1d",
"category": "NETWORK_CONNECTIVITY",
"total_event": 2,
"total_active": 2
},
{
"category_id": "c9d0e1f2-a3b4-4c5d-6e7f-8a9b0c1d2e3f",
"category": "OPERATIONAL_MAINTENANCE",
"total_event": 1
},
{
"category_id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
"category": "SECURITY_ACCESS_CONTROL",
"total_event": 14,
"total_active": 11
},
{
"category_id": "d4e5f6a7-b8c9-4d5e-1f2a-3b4c5d6e7f8a",
"category": "SYSTEM_HEALTH_PERFORMANCE",
"total_event": 4,
"total_active": 4
},
{
"category_id": "f6a7b8c9-d0e1-4f5a-3b4c-5d6e7f8a9b0c",
"category": "USER_ROLE_MANAGEMENT",
"total_event": 7,
"total_active": 2
}
],
"pagination": {
"total": 9,
"page": 1,
"page_size": 20,
"last_page": 1
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| category_id | UUID | Identifier of the notification category |
| category | String | Name of the notification category |
| total_event | Integer | Total number of events defined within the category |
| total_active | Integer | Number of active events within the category |
| total | Integer | Total number of categories 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
total_activefield may not be present when a category has no active events.