Database
Community
Enterprise

Delete your BloodHound data

Changed on

Wipes your BloodHound data permanently. Specify the data to delete in the request body. Possible data includes collected graph data, relationships of specific types, custom high value selectors, file ingest history, and data quality history.

post/api/v2/clear-database

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/clear-database
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Request body

deleteCollectedGraphDataboolean

When true, deletes all collected graph nodes and edges. Cannot be combined with deleteSourceKinds or deleteRelationships.

deleteSourceKindsinteger[]

A list of source kind IDs (from the source_kinds table) whose associated graph nodes and source kind records will be deleted. Use 0 as a special value to delete all "sourceless" nodes - nodes that exist in the graph but are not attributed to any source kind. Non-existent IDs will result in a 400 error.

deleteRelationshipsstring[]

A list of relationship kind names (e.g. "HasSession") whose edges will be deleted from the graph. Each value must be a valid, known relationship kind. Cannot be combined with deleteCollectedGraphData.

deleteFileIngestHistoryboolean

When true, deletes all file ingest job history records.

deleteDataQualityHistoryboolean

When true, deletes all data quality history records.

deleteAssetGroupSelectorsinteger[]

A list of asset group IDs whose custom selectors will be deleted. Triggers a re-analysis after deletion.

Response

No Content This response will contain no response body.

Changes