## Endpoint: `/api/alerts/?wanted={status}&start={time} **Method:** GET **Description:** Fetch all alerts based on status and time. ### Parameters | **Parameter** | **Type** | **Required** | **Description** | **Example Value** | | ------------- | -------- | ------------ | ----------------------------- | ------------------ | | wanted | String | Yes | Specifies the alert status. | all | | start | String | Yes | The specific date for alerts. | YYYY-MM-DDT:mm:ssZ | ###### Note: Time format **YYYY-MM-DDT:mm:ssZ** is in UTC. **Example:** for alert received at 12:00:00PM in Israel, the value of time is 2025-01-01T10:00:00Z ### Example Response { "data": [ { ...ALERT DETAILS... } ], "total": 1, "request_key": null, "flat_count": -1, "real_page": 1, "noteboard_count": 0 } --- ## Endpoint: `/api/alerts/{alert_id}/` **Method:** GET **Description:** Fetch specific alert. ### Parameters |**Parameter**|**Type**|**Required**|**Description**|**Example Value**| |---|---|---|---|---| |alert_id|String|Yes|Unique identifier for the alert.|98765| ### Example Request `GET /api/alerts/{alert_id}/` ### Example Response { "id": 29917452, ... EVENT DETAILS ... "audits": [ { ... ACTIONS DETAILS ... } ], "todo": null, "flows": null, "audits": [ { "id": 106500795, "user": { "username": "JohnDoe", ..THE REST OF USER'S DETAILS }, "action": { "id": 61, "action": { ... ACTION DETAILS ... }, }, ...MORE DETAILS ABOUT THE ACTION... } ], ...DETAILS ABOUT THE ALERT... } --- ## Endpoint: `/api/events/options/` **Method:** GET **Description:** Retrieve options for the customer returns, groups, smart_rules, templates, sources, severities, users, services, and off_hours. ### Parameters |**Parameter**|**Type**|**Required**|**Description**|**Example Value**| |---|---|---|---|---| |None|-|-|No parameters required.|-| ### Example Response { "groups": [ ... GROUPS DETAILS ... ], "smart_rules": [], "templates": [ ... TEMPLATES DETAILS ... ], "sources": [ ... SOURCES DETAILS ... ] ... REST OF THE DETAILS ... } --- ## Endpoint: `/api/alert-audit/` **Method:** POST **Description:** Process an action on an alert by specifying the action ID, adding the snooze minutes, and adding comment text (audit). ### Parameters |**Parameter**|**Type**|**Required**|**Description**|**Example Value**| |---|---|---|---|---| |None|-|-|No parameters required.|-| ### Example Request `POST /api/alert-audit/` ### Example Payload **Please Replace {VALUE} with the desired value** { "params": { "minutes": 5, "contact": "{contact_name}" }, "alert": "{alert_id}", "action": "{action_id}", "comment": {comment} } --- ## Endpoint: `/api/alert-audit/` **Method:** GET **Description:** Fetch all the audits for all the alerts with all the relevant details. ### Parameters | **Parameter** | **Type** | **Required** | **Description** | **Example Value** | |---------------|----------|--------------|--------------------------|-------------------| | None | - | - | No parameters required. | - | ### Example Request `GET /api/alert-audit/` ### Example Response "results": [ { "id": "alert_id", "id": 1755557, "user": null, "action": { "id": 980, "action": { "id": 22, "name": "created", ...ADDITIONAL ACTION DETAILS... }, }, "created": "2016-08-10T18:06:03.551931Z", "updated": "2019-07-18T07:03:22.746550Z", ...ADDITIONAL ACTION DETAILS... } --- ## Endpoint: `/api/alerts/counters/?format=json&customer={customer_id}` **Method:** GET **Description:** Return the count of the alerts in each state: active, in_progress, recovered, onhold. ### Parameters | **Parameter** | **Type** | **Required** | **Description** | **Example Value** | |---------------|----------|--------------|--------------------------------------|-------------------| | customer | Integer | Yes | A unique integer value identifying the customer. | 54 | ### Example Response { "active": 1, "in_progress": 0, "recovered": 0, "onhold": 0 } --- ## Endpoint: `/api/alert-audit/{id}/` **Method:** GET **Description:** Get the audit details based on the audit ID. #### Parameters | **Parameter** | **Type** | **Required** | **Description** | **Example Value** | |---------------|----------|--------------|--------------------------------------|-------------------| | id | String | Yes | Unique identifier for the alert audit. | 12345 | ### Example Request `GET /api/alert-audit/{audit_id}/` ### Example Response { "id": {audit_id}, "user": null, "action": { "id": {action_id}, "action": { "id": 22, "name": "created", ...ADDITIONAL ACTION DETAILS... }, }, "created": "2016-08-10T18:06:03.551931Z", "updated": "2019-07-18T07:03:22.746550Z", ...ADDITIONAL ACTION DETAILS... } ---