Event

The Event endpoint allows you to get a list of all events or event types, details about specific events, and delete events.

Get a list of events.

GET https://api.halosecurity.com/api/v1/event/list.json

Returns a paginated list of events.

https://www.halosecurity.com/user/security/events/list

Query Parameters

Name	Type	Description
sort	Integer	0 = name (default)
sort_desc	Integer	0 = No (default) 1 = Yes
key	String	Filter by key
subject	String	Filter by subject
detail	String	Filter by detail
target_id	Integer	Filter by target id

200: OK

{
    "list": [
        {
            "event": {
                "event_id": "id1",
                "subject": "Scan Started",
                "date_created": "0000-00-00 00:00",
                "key": "target-scan-start",
                "url": "https://www.halosecurity.com/link?q=user-event&id=id1",
                "target": {
                    "target_name": "",
                    "target_id": 1,
                    "target": "www.example.com"
                }
            }
        }
    ]
}

Get the details of an event.

GET https://api.halosecurity.com/api/v1/event/get.json

Returns the details of an event.

https://www.halosecurity.com/user/security/events/list

Query Parameters

Name	Type	Description
event_id*	String

200: OK

{
    "success": 1,
    "event": {
        "event_id": "id1",
        "subject": "Scan Started",
        "date_created": "0000-00-00 00:00",
        "key": "target-scan-start",
        "url": "https://www.halosecurity.com/link?q=user-event&id=id1",
        "target": {
            "target_name": "",
            "target_id": 1,
            "target": "www.example.com"
        }
    }
}

400: Bad Request

{
    "code": 0,
    "message": "event_id required"
}

404: Not Found

{
    "code": 404,
    "message": "event not found"
}

Delete an event.

GET https://api.halosecurity.com/api/v1/event/delete.json

Returns the event deletion status.

https://www.halosecurity.com/user/security/events/list

Query Parameters

Name	Type	Description
event_id*	String

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "event_id required"
}

404: Not Found

{
    "code": 404,
    "message": "event not found"
}

Get a list of event types.

GET https://api.halosecurity.com/api/v1/event/types.json

Returns a paginated list of event types.

https://www.halosecurity.com/user/security/events/alert-rules

200: OK

{
    "list": [
        {
            "subject": "API Key Added",
            "key": "account-apikey-add"
        }
    ]
}