About Events API
The Argus events API provides endpoints for searching and fetching events, as well as event statistics.
The Event API uses role based access control, so any search will be limited to the customers for which the user has permission to view events.
In addition, fetching events by case provides access to the events associated with that case, provided that the user has read access to the case.
Please read the General Integration Guide to learn the general concepts and common data structures used throughout the Argus API.
Detailed API documentation
The Swagger API documentation is always up-to-date and lets you try out any query with your user session or an API-key.
Fetch a single event
To fetch an event, append the event ID to the base URL
This returns the entire event:
Searching for events
To search for events, query the "aggregated" endpoint to search among all security events.
See Swagger API documentation for details on available query parameters
To do more advanced filtering, use the advanced search endpoint.
The advanced search endpoint requires a startTimestamp.
See Swagger API documentation under
events/events/v1/aggregated/search for example of usage, or go to
Models/AggregatedEventSearchCriteria for details on available query parameters.
Searching by IP - CIDR ranges
Argus will by default resolve any CIDR IP range to match any IP contained within that range.
Moreover, Argus will also widen the search to include any covering ranges, i.e. any CIDR range with lower maskbits than specified which will contain the specified range/IP.
Example: Searching for 192.168.1.32/28
- Will match CIDR range 192.168.1.32/28
- Will match IP 192.168.1.33 (part of 192.168.1.32/28)
- Will match CIDR range 192.168.1.40/29 (part of 192.168.1.32/28)
- Will match CIDR range 192.168.1.0/24 (covers 192.168.1.32/28)
- Will match CIDR range 0.0.0.0/0 (covers 192.168.1.32/28)
To control this behaviour, use parameters
destinationIPMinBits. Setting these parameters will limit how wide CIDR ranges will be considered.
Any CIDR range specified in the search criteria will be searched for, even if the CIDR range has a lower maskbits than specified in these criteria.
Fetching events associated to a case
To fetch events associated with a case, use the eventsByCase endpoint
Fetching large amounts of events
To pull out large amounts of events, it is important to select a strategy which is resource-efficient for both the server and client, as well as a robust strategy which will leave you with a complete dataset. There are several ways for doing this, all depending on your use case.
Common for all strategies
- Use a medium-size limit to avoid fetching too big resultsets, but big enough to make transfer efficient
- Use a clear sorting and limiting strategy to ensure that you will end up with a complete dataset
Pulling events continuously
This strategy fetches events in the order they are written in the event store. If an event is updated and written again, it will be returned again.
This strategy is well suited for fetching events continously and near real-time.
This will fetch the first 1000 events sorted by event lastUpdatedTimestamp. The response
Subsequent requests should use the lastUpdatedTimestamp value of the last event in the previous result, to fetch the next 1000 events.
- No labels