Gets analysis request information

Flags the API to request the information of an analysis request.

GET /api/v2/analysis

Gets analysis request information

cURL

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

200

{
  "requested_by": "<string>",
  "request_type": "<string>",
  "requested_at": "2023-11-07T05:31:56Z",
  "delete_all_graph": true,
  "delete_sourceless_graph": true,
  "delete_source_kinds": [
    "<string>"
  ]
}

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

Response

200

application/json

OK

requested_by · string

request_type · string

requested_at · string<date-time>

delete_all_graph · boolean

delete_sourceless_graph · boolean

delete_source_kinds · string[]