Run a cypher query

Runs a manual cypher query directly against the database.

POST /api/v2/graphs/cypher

Run a cypher query

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/graphs/cypher \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "include_properties": true
}
'

200

{
  "data": {
    "node_keys": [
      "<string>"
    ],
    "edge_keys": [
      "<string>"
    ],
    "nodes": {},
    "edges": [
      {
        "source": "<string>",
        "target": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "lastSeen": "2023-11-07T05:31:56Z",
        "properties": {}
      }
    ],
    "literals": [
      {
        "key": "<string>",
        "value": {}
      }
    ]
  }
}

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]+)$

Body

application/json

query · string

include_properties · boolean

Response

200

application/json

OK

data · object

Show child attributes