Run a cypher query

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

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

POST

api

graphs

cypher

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

Authorizations

Authorization

string

header

required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer

integer

default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Body

application/json

query

string

include_properties

boolean

Response

data

object

Show child attributes

Revokes permission of a saved query from users Get Azure entity

⌘I

Get Started

Auth

Permissions

Roles

API Tokens

BloodHound Users

Collectors

Collection Uploads

API Info

Search

Audit

Config

Asset Isolation

Graph

Cypher

Azure Entities

AD Base Entities

Computers

Containers

Domains

GPOs

AIA CAs

Root CAs

Enterprise CAs

NT Auth Stores

Cert Templates

OUs

AD Users

Groups

Data Quality

Database

Datapipe

EULA

Analysis

Client Ingest

Clients

Jobs

Events (Schedules)

Attack Paths

Risk Posture

Meta Entities

Authorizations

Headers

Body

Response