Gets analysis request information

Returns the current analysis request information. Always returns 200 OK with the request details. When no request is pending, returns a zero-valued response with empty strings, false booleans, null arrays, and zero timestamp.

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

{
  "data": {
    "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>"
    ],
    "delete_relationships": [
      "<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. Returns analysis request details if one exists, or a zero-valued response if no request is pending (requested_by and request_type will be empty strings, requested_at will be "0001-01-01T00:00:00Z", booleans will be false, and arrays will be null).

data · object

Show child attributes