SpecterOps

SpecterOps Custom Node Management API

The Custom Node Management API from SpecterOps — 2 operation(s) for custom node management.

GitHub OpenAPI

Operations 5

GET /api/v2/custom-nodes Get custom nodes #
POST /api/v2/custom-nodes Create custom nodes #
GET /api/v2/custom-nodes/{kind_name} Get custom node #
PUT /api/v2/custom-nodes/{kind_name} Update custom node #
DELETE /api/v2/custom-nodes/{kind_name} Delete custom node (Deprecated) #

Documentation

📖
APIReference
https://bloodhound.specterops.io/reference/overview
📖
Documentation
https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/specterops/refs/heads/main/openapi/specterops-custom-node-management-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/specterops-custom-node-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

specterops-custom-node-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BloodHound Custom Node Management API
  contact:
    name: BloodHound Enterprise Support
    url: https://bloodhound.specterops.io/
    email: support@specterops.io
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: v2
  description: This is the API that drives BloodHound Enterprise and Community Edition.
servers:
- url: /
  description: This is the base path for all endpoints, relative to the domain where the API is being hosted.
security:
- JWTBearerToken: []
- SignedRequest: []
  RequestDate: []
  HMACSignature: []
tags:
- name: Custom Node Management
paths:
  /api/v2/custom-nodes:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    get:
      operationId: GetCustomNodes
      summary: Get custom nodes
      description: 'Retrieve a list of all custom node configurations.

        This endpoint returns the current set of registered node kinds and their display settings.'
      tags:
      - Custom Node Management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/model.custom-node'
              example:
                data:
                - id: 1
                  kindName: KindA
                  config:
                    icon:
                      type: font-awesome
                      name: house
                      color: '#FFFFFF'
                - id: 2
                  kindName: KindB
                  config:
                    icon:
                      type: font-awesome
                      name: coffee
                      color: '#000000'
        '401':
          $ref: '#/components/responses/unauthorized'
        '500':
          $ref: '#/components/responses/internal-server-error'
    post:
      operationId: CreateCustomNodes
      summary: Create custom nodes
      description: 'This endpoint registers new node kinds along with optional display metadata such as icons and colors.

        The provided configuration controls how nodes of the specified kinds are interpreted and rendered in the UI.

        Only free, solid-style Font Awesome icons are supported. Hex color codes must follow the format #RGB or #RRGGBB.

        If no valid icon or color is provided, the system will fall back to a question mark icon and a white background color.

        Batch input is supported; you may submit multiple configuration objects in a single request.'
      tags:
      - Custom Node Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_types:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/model.custom-node.config'
            example:
              custom_types:
                KindA:
                  icon:
                    type: font-awesome
                    name: house
                    color: '#FFFFFF'
                KindB:
                  icon:
                    type: font-awesome
                    name: coffee
                    color: '#000000'
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/model.custom-node'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '409':
          description: '**Conflict**

            Duplicate Kind Name

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.error-wrapper'
              example:
                http_status: 409
                timestamp: '2024-02-19T19:27:43.866Z'
                request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                errors:
                - context: customnodes
                  message: 'Conflict: duplicate kind name'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/custom-nodes/{kind_name}:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: kind_name
      description: Kind Name
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: GetCustomNode
      summary: Get custom node
      description: 'Retrieve the configuration for a specific custom node kind.

        Returns the display settings and metadata for the requested node kind.'
      tags:
      - Custom Node Management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.custom-node'
              example:
                id: 1
                kindName: KindA
                config:
                  icon:
                    type: font-awesome
                    name: house
                    color: '#FFFFFF'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
    put:
      operationId: UpdateCustomNode
      summary: Update custom node
      description: 'This endpoint updates an existing node kind along with optional display metadata such as icons and colors.

        The provided configuration controls how nodes of the specified kinds are interpreted and rendered in the UI.

        Only free, solid-style Font Awesome icons are supported. Hex color codes must follow the format #RGB or #RRGGBB.

        If no valid icon or color is provided, the system will fall back to a question mark icon and a white background color.'
      tags:
      - Custom Node Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                config:
                  $ref: '#/components/schemas/model.custom-node.config'
            example:
              config:
                icon:
                  type: font-awesome
                  name: house
                  color: '#333'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.custom-node'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
    delete:
      operationId: DeleteCustomNode
      deprecated: true
      summary: Delete custom node (Deprecated)
      description: '**Deprecated**: This endpoint is no longer supported and will return 410 Gone.'
      tags:
      - Custom Node Management
      responses:
        '401':
          $ref: '#/components/responses/unauthorized'
        '410':
          description: Gone - This endpoint has been deprecated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.error-wrapper'
components:
  responses:
    internal-server-error:
      description: '**Internal Server Error**

        This is usually the result of either an unexpected database or application error.

        The client may try modifying or resending the request, but the error is likely not related to the client

        doing something wrong.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api.error-wrapper'
          example:
            http_status: 500
            timestamp: '2024-02-19T19:27:43.866Z'
            request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            errors:
            - context: clients
              message: The request could not be handled due to an unexpected database error.
    unauthorized:
      description: '**Unauthorized**

        This endpoint failed an authentication requirement. Either the client tried to access

        a protected endpoint without being authenticated, or an auth validation failed (ex- invalid

        credentials or expired token).

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api.error-wrapper'
          example:
            http_status: 401
            timestamp: '2024-02-19T19:27:43.866Z'
            request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            errors:
            - context: login
              message: Unauthorized
    not-found:
      description: '**Not Found**

        This error typically comes from operations where a valid ID was passed to the request

        to look up an entity but the entity could not be found.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api.error-wrapper'
          example:
            http_status: 404
            timestamp: '2024-02-19T19:27:43.866Z'
            request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            errors:
            - context: clients
              message: The requested client could not be found.
    bad-request:
      description: '**Bad Request**

        This could be due to one of the following reasons:

        - JSON payload is missing or malformed

        - Path or query parameters are missing or invalid/malformed

        - The data sent is not valid (ex- sending a `string` in an `integer` field)

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api.error-wrapper'
          example:
            http_status: 400
            timestamp: '2024-02-19T19:27:43.866Z'
            request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            errors:
            - context: clients
              message: The JSON payload could not be unmarshalled.
  schemas:
    api.error-detail:
      type: object
      properties:
        context:
          type: string
          description: The context in which the error took place
        message:
          type: string
          description: A human-readable description of the error
    model.custom-node.config:
      type: object
      properties:
        icon:
          type: object
          properties:
            type:
              type: string
            name:
              type: string
            color:
              type: string
    api.error-wrapper:
      type: object
      description: ''
      properties:
        http_status:
          type: integer
          description: The HTTP status code
          minimum: 100
          maximum: 600
        timestamp:
          type: string
          format: date-time
          description: The RFC-3339 timestamp in which the error response was sent
        request_id:
          type: string
          format: uuid
          description: The unique identifier of the request that failed
        errors:
          type: array
          items:
            $ref: '#/components/schemas/api.error-detail'
          description: The error(s) that occurred from processing the request
    model.custom-node:
      type: object
      properties:
        id:
          type: integer
        kindName:
          type: string
        config:
          $ref: '#/components/schemas/model.custom-node.config'
  parameters:
    header.prefer:
      name: Prefer
      description: 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.
      in: header
      required: false
      schema:
        type: string
        default: wait=30
        pattern: ^wait=(-1|[0-9]+)$
  securitySchemes:
    JWTBearerToken:
      description: '`Authorization: Bearer $JWT_TOKEN`

        '
      type: http
      scheme: bearer
      bearerFormat: JWT
    SignedRequest:
      description: '`Authorization: bhesignature $TOKEN_ID`

        '
      type: apiKey
      name: Authorization
      in: header
    RequestDate:
      description: '`RequestDate: $RFC3339_DATETIME`

        '
      type: apiKey
      name: RequestDate
      in: header
    HMACSignature:
      description: '`Signature: $BASE64ENCODED_HMAC_SIGNATURE`

        '
      type: apiKey
      name: Signature
      in: header
x-tagGroups:
- name: Community & Enterprise
  tags:
  - Auth
  - Roles
  - Permissions
  - API Tokens
  - BloodHound Users
  - Collectors
  - Collection Uploads
  - Custom Node Management
  - API Info
  - Search
  - Audit
  - Config
  - Asset Isolation
  - Graph
  - Azure Entities
  - AD Base Entities
  - Computers
  - Containers
  - Domains
  - GPOs
  - AIA CAs
  - Root CAs
  - Enterprise CAs
  - NT Auth Stores
  - Cert Templates
  - OUs
  - AD Users
  - Groups
  - Data Quality
  - Datapipe
  - Cypher
  - OpenGraph (Experimental)
- name: Enterprise Only
  tags:
  - EULA
  - BHE Users
  - Analysis
  - Client Ingest
  - Clients
  - Jobs
  - Tasks
  - Events (Schedules)
  - Attack Paths
  - Risk Posture
  - Meta Entities
  - Alerts