Skip to content

Query Investigations

Request

Queries investigations

Operation ID: siem_query_investigations

Security
BearerAuth
Query
metaArray of strings

Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.

cursorstring or null

Cursor to use to retrieve the next page of results.

limitinteger or null

Number of Investigation objects to return in this page. Defaults to 100. A page may hold fewer results than limit, or none, even when more remain; keep paging until the returned cursor is empty.

orderArray of strings

Select a field to order the results by.

filterArray of strings

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

include_raw_databoolean or null

Include the raw data from the SIEM in the response. Defaults to false.

curl
curl -i -X GET \
  https://api.synqly.com/v1/siem/investigations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
cursorstringrequired

Cursor to use to retrieve the next page of results

resultArray of objects(Investigation)required

List of investigations

messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

Response
{ "result": [ { … } ], "cursor": "string", "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }