\QueryApi

May 24, 2025 ยท View on GitHub

All URIs are relative to http://localhost:9000/api

MethodHTTP requestDescription
find_entities_by_queryPOST /v1/queryFind entities using a flexible query

find_entities_by_query

models::FindEntitiesByQuery200Response find_entities_by_query(input_query, x_organisation, name) Find entities using a flexible query

Generic endpoint to query various TheHive entities. The structure of the response depends on the name query parameter and the query itself.

Parameters

NameTypeDescriptionRequiredNotes
input_queryInputQuery[required]
x_organisationOption<String>Specifies the organisation context for the request.
nameOption<String>The type of entity or pre-defined query to run (e.g., "alerts", "cases", "alert-observables").

Return type

models::FindEntitiesByQuery200Response

Authorization

basicAuth, apiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]