Delete your BloodHound data

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

Delete your BloodHound data

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/clear-database \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deleteCollectedGraphData": true,
  "deleteRelationships": [
    "<string>"
  ],
  "deleteFileIngestHistory": true,
  "deleteDataQualityHistory": true,
  "deleteAssetGroupSelectors": [
    123
  ]
}
'

204

"[this request has no response 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]+)$

Body

application/json

deleteCollectedGraphData · boolean

deleteRelationships · string[]

deleteFileIngestHistory · boolean

deleteDataQualityHistory · boolean

deleteAssetGroupSelectors · integer[]

Response

204

text/plain

No Content This response will contain no response body.

The response is of type string.