SpecterOps · OpenAPI Overlay 1.0.0

API Evangelist enhancements for BloodHound API

2 actions 2 updates update extends openapi/specterops-bloodhound-openapi.json

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-productx-apievangelist-authx-apievangelist-error-envelopex-apievangelist-paginationx-apievangelist-note

Targets 2

$.info

$.servers

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for BloodHound API
  version: 1.0.0
extends: openapi/specterops-bloodhound-openapi.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: specterops
    x-apievangelist-product: BloodHound
    x-apievangelist-auth: [JWT bearer, HMAC signed request (bhesignature)]
    x-apievangelist-error-envelope: api.error-wrapper
    x-apievangelist-pagination: skip/limit offset paging with sort-by
- target: $.servers
  update:
    x-apievangelist-note: The published server URL is "/" (relative); the API is hosted per-tenant at
      https://<tenant>.bloodhoundenterprise.io or on a self-managed BloodHound instance.