SpecterOps Domains API

openapi: 3.0.3
info:
  title: BloodHound AD Base Entities Domains 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.\nEndpoint availability is denoted using the `Community` and `Enterprise` tags.\n\nContact information listed is for BloodHound Enterprise customers. To get help with\nBloodHound Community Edition, please join our\n[Slack community](https://ghst.ly/BHSlack/).\n\n## Authentication\n\nThe BloodHound API supports two kinds of authentication: JWT bearer tokens and Signed Requests.\nFor quick tests or one-time calls, the JWT used by your browser may be the simplest route. For\nmore secure and long lived API integrations, the recommended option is signed requests.\n\n### JWT Bearer Token\n\nThe API will accept calls using the following header structure in the HTTP request:\n```\nAuthorization: Bearer $JWT_TOKEN\n```\nIf you open the Network tab within your browser, you will see calls against the API made utilizing\nthis structure. JWT bearer tokens are supported by the BloodHound API, however it is recommended\nthey only be used for temporary access. JWT tokens expire after a set amount of time and require\nre-authentication using secret credentials.\n\n### Signed Requests\n\nSigned requests are the recommended form of authentication for the BloodHound API. Not only are\nsigned requests better for long lived integrations, they also provide more security for the\nrequests being sent. They provide authentication of the client, as well as verification of request\nintegrity when received by the server.\n\nSigned requests consist of three main parts: The client token ID, the request timestamp, and a\nbase64 encoded HMAC signature. These three pieces of information are sent with the request using\nthe following header structure:\n\n```\nAuthorization: bhesignature $TOKEN_ID\nRequestDate: $RFC3339_DATETIME\nSignature: $BASE64ENCODED_HMAC_SIGNATURE\n```\n\nTo use signed requests, you will need to generate an API token. Each API token generated in the\nBloodHound API comes with two parts: The Token ID, which is used in the `Authorization` header,\nand the Token Key, which is used as part of the HMAC hashing process. The token ID should be\nconsidered as public (like a username) and the token key should be considered secret (like a\npassword). Once an API token is generated, you can use the key to sign requests.\n\nFor more documentation about how to work with authentication in the API, including examples\nof how to generate an API token in the BloodHound UI, please refer to this support doc:\n[Working with the BloodHound API](https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api).\n\n#### Signed Request Pseudo-code Example\n\nFirst, a digest is initiated with HMAC-SHA-256 using the token key as the digest key:\n```python\ndigester = hmac.new(sha256, api_token_key)\n```\n\nOperationKey is the first HMAC digest link in the signature chain. This prevents replay attacks that\nseek to modify the request method or URI. It is composed of concatenating the request method and\nthe request URI with no delimiter and computing the HMAC digest using the token key as the digest\nsecret:\n```python\n# Example: GET /api/v2/test/resource HTTP/1.1\n# Signature Component: GET/api/v2/test/resource\ndigester.write(request_method + request_uri)\n\n# Update the digester for further chaining\ndigester = hmac.New(sha256, digester.hash())\n```\n\nDateKey is the next HMAC digest link in the signature chain. This encodes the RFC3339\nformatted datetime value as part of the signature to the hour to prevent replay\nattacks that are older than max two hours. This value is added to the signature chain\nby cutting off all values from the RFC3339 formatted datetime from the hours value\nforward:\n```python\n# Example: 2020-12-01T23:59:60Z\n# Signature Component: 2020-12-01T23\nrequest_datetime = date.now()\ndigester.write(request_datetime[:13])\n\n# Update the digester for further chaining\ndigester = hmac.New(sha256, digester.hash())\n```\n\nBody signing is the last HMAC digest link in the signature chain. This encodes the\nrequest body as part of the signature to prevent replay attacks that seek to modify\nthe payload of a signed request. In the case where there is no body content the\nHMAC digest is computed anyway, simply with no values written to the digester:\n```python\nif request.body is not empty:\n  digester.write(request.body)\n```\n\nFinally, base64 encode the final hash and write the three required headers before\nsending the request:\n```python\nencoded_hash = base64_encode(digester.hash())\nrequest.header.write('Authorization', 'bhesignature ' + token_id)\nrequest.header.write('RequestDate', request_datetime)\nrequest.header.write('Signature', encoded_hash)\n```\n"
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: Domains
paths:
  /api/v2/domains/{object_id}:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntity
      summary: Get domain entity info
      description: Get basic info and counts for this domain node.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.hydrate-counts'
      responses:
        '200':
          $ref: '#/components/responses/entity-info-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
    patch:
      operationId: UpdateDomainEntity
      summary: Update the Domain entity
      description: Updates the supported properties on the Domain entity.
      tags:
      - Domains
      requestBody:
        description: The patch request body for updating Domain
        content:
          application/json:
            schema:
              type: object
              properties:
                collected:
                  type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      collected:
                        type: boolean
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/computers:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityComputers
      summary: Get domain entity computers
      description: Get a list or count of the computers that belong to this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/controllers:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityControllers
      summary: Get domain entity controllers
      description: Get a list, graph, or count of the principals that can control this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/dc-syncers:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityDcSyncers
      summary: Get domain entity DC Syncers
      description: Get a list, graph, or count of the principals that can DC sync this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/foreign-admins:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityForeignAdmins
      summary: Get domain entity foreign admins
      description: 'Get a list, graph, or count of the principals outside of this domain that have admin

        rights on principals in this domain.

        '
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/foreign-gpo-controllers:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityForeignGpoControllers
      summary: Get domain entity foreign GPO controllers
      description: 'Get a list, graph, or count of the principals outside of this domain that can control

        GPOs inside this domain.

        '
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/foreign-groups:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityForeignGroups
      summary: Get domain entity foregin groups
      description: 'Get a list, graph, or count of the groups outside of this domain that are members

        of groups inside this domain.

        '
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/foreign-users:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityForeignUsers
      summary: Get domain entity foreign users
      description: 'Get a list, graph, or count of the users outside of this domain that are members

        of groups inside this domain.

        '
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/gpos:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityGpos
      summary: Get domain entity GPOs
      description: Get a list or count of the GPOs in this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/groups:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityGroups
      summary: Get domain entity groups
      description: Get a list or count of the groups in this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/inbound-trusts:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityInboundTrusts
      summary: Get domain entity inbound trusts
      description: Get a list, graph, or count of the inbound trusts for this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/linked-gpos:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityLinkedGpos
      summary: Get domain entity linked GPOs
      description: Get a list, graph, or count of the GPOs linked to this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/ous:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityOus
      summary: Get domain entity OUs
      description: Get a list or count of the OUs in this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/outbound-trusts:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityOutboundTrusts
      summary: Get domain entity outbound trusts
      description: Get a list, graph, or count of the outbound trusts for this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/users:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityUsers
      summary: Get domain entity users
      description: Get a list or count of the users in this domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/domains/{object_id}/adcs-escalations:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - $ref: '#/components/parameters/path.object-id'
    get:
      operationId: GetDomainEntityAdcsEscalations
      summary: Get ADCS escalations of Domain entity
      description: Get a list, graph, or count of the ADCS escalations of this Domain.
      tags:
      - Domains
      parameters:
      - $ref: '#/components/parameters/query.entity.skip'
      - $ref: '#/components/parameters/query.entity.limit'
      - $ref: '#/components/parameters/query.entity.type'
      - $ref: '#/components/parameters/query.entity.sort-by'
      responses:
        '200':
          $ref: '#/components/responses/related-entity-query-results'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
components:
  parameters:
    query.hydrate-counts:
      description: Include counts of related entities. Default value is `true`.
      name: counts
      in: query
      schema:
        type: boolean
        default: true
    query.entity.type:
      name: type
      description: 'The type of return data requested. If no type is provided, query will default to `list`.

        The only supported type is `list`, but the unsupported `graph` type can be used.

        Some entity query endpoints do not support the `graph` type. For those interested in

        using the undocumented graph type parameter, the response type is described in the schema

        `model.bh-graph.graph`.

        '
      in: query
      schema:
        type: string
        default: list
        enum:
        - list
        - graph
    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]+)$
    query.entity.limit:
      name: limit
      description: The number of entries to limit in the response. Only available for `type=list`.
      in: query
      schema:
        type: integer
        minimum: 0
        default: 10
    query.entity.sort-by:
      name: sort_by
      in: query
      description: 'Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available

        for sorting are dependent on the entity object kind.

        '
      schema:
        $ref: '#/components/schemas/api.params.query.sort-by'
    path.object-id:
      name: object_id
      description: The object id of the entity being operated on.
      in: path
      required: true
      schema:
        type: string
        description: The unique object identifier
    query.entity.skip:
      name: skip
      description: The number of entries to skip for pagination. Only available for `type=list`.
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
  responses:
    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.
    forbidden:
      description: '**Forbidden**

        This is most commonly caused by an authenticated client trying to

        access a resource that it does not have permission for.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api.error-wrapper'
          example:
            http_status: 403
            timestamp: '2024-02-19T19:27:43.866Z'
            request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            errors:
            - context: clients
              message: You do not have permission to access this resource
    too-many-requests:
      description: '**Too Many Requests**

        The client has sent too many requests within a certain time window

        and tripped the rate limiting middleware.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api.error-wrapper'
          example:
            http_status: 429
            timestamp: '2024-02-19T19:27:43.866Z'
            request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
            errors:
            - context: middleware
              message: Too many requests. Please try again later.
    related-entity-query-results:
      description: '**OK**


        This endpoint returns a response, dependent upon which return type is requested by the `type` parameter.

        The only supported `type` parameter is `list`.

        While `list` is the only supported `type` parameter, the `graph` parameter can be used

        and will result in a different response structure then documented here.

        For those interested in using the undocumented graph type parameter, the response type is described in the schema

        `model.bh-graph.graph`.

        '
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/api.response.pagination'
            - title: list
              type: object
              properties:
                data:
                  type: array
                  items:
                    title: paged-node-list-entry
                    type: object
                    properties:
                      objectID:
                        type: string
                      name:
                        type: string
                      label:
                        type: string
                      kinds:
                        type: array
                        items:
                          type: string
    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.
    entity-info-query-results:
      description: '**OK**


        This response is polymorphic and depends on the type of entity being queried and whether

        the `count` param is true or not. All node types will return a `props` field with the graph node

        properties and a `kinds` field with the graph node kinds. If `count=true` the response will also include additional fields with integer counts.

        '
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                properties:
                  kinds:
                    type: array
                    items:
                      type: string
                  props:
                    type: object
                    additionalProperties:
                      type: object
    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
  schemas:
    api.response.pagination:
      type: object
      properties:
        count:
          type: integer
          minimum: 0
          description: The total number of results.
        skip:
          $ref: '#/components/schemas/api.params.query.skip'
        limit:
          $ref: '#/components/schemas/api.params.query.limit'
    api.params.query.limit:
      type: i

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/specterops/refs/heads/main/openapi/specterops-domains-api-openapi.yml