Get API Spec

Returns an Open API 3.0 compatible BloodHound API spec

GET /api/v2/spec

Get API Spec

cURL

curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/spec

200

"openapi: 3.0.3\nservers:\n  - url: /\n...[truncated example]\n"

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

text/x-yaml

OK

The response is of type file.