Get search result

Get the result of searching a graph for a node by name

GET /api/v2/graph-search

Get search result

cURL

curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/graph-search \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {}
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · string · default: wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Query Parameters

query · string · required

Search query

type · enum<string>

The type of search strategy to use. Default is fuzzy.

Available options: fuzzy, exact

Response

200

application/json

OK

data · object

Show child attributes