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-clients-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: BloodHound Clients 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: Clients
paths:
  /api/v2/clients:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    get:
      operationId: ListClients
      summary: List Clients
      description: Lists available clients for processing collection events.
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/query.created-at'
      - $ref: '#/components/parameters/query.updated-at'
      - $ref: '#/components/parameters/query.deleted-at'
      - $ref: '#/components/parameters/query.clients.hydrate-domains'
      - $ref: '#/components/parameters/query.clients.hydrate-ous'
      - $ref: '#/components/parameters/query.skip'
      - $ref: '#/components/parameters/query.limit'
      - name: sort_by
        description: Sortable columns are `name`, `ip_address`, `hostname`, `configured_user`, `last_checkin`, `completed_job_count`, `created_at`, `updated_at`, `deleted_at`.
        in: query
        schema:
          $ref: '#/components/schemas/api.params.query.sort-by'
      - name: name
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: ip_address
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: hostname
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: configured_user
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: version
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: user_sid
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: last_checkin
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: current_job_id
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.integer'
      - name: completed_job_count
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.integer'
      - name: domain_controller
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.string'
      - name: id
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.uuid'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api.response.pagination'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/model.client-display'
        '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'
    post:
      operationId: CreateClient
      summary: Create Client
      description: Creates a client for collection events
      tags:
      - Clients
      requestBody:
        description: The request body for creating a client
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                domain_controller:
                  type: string
                type:
                  $ref: '#/components/schemas/enum.client-type'
                events:
                  type: array
                  items:
                    $ref: '#/components/schemas/model.client-schedule'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client'
        '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/clients/error:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    post:
      operationId: LogClientError
      summary: Client Error
      description: 'Endpoint for clients to log enumeration errors.


        Note: caller must be a client. For users, this endpoint will return a 404 as

        they are not expected or allowed to call this endpoint.

        '
      tags:
      - Clients
      requestBody:
        description: The request body for logging a client enumeration error
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                task_error:
                  type: string
                additional:
                  type: object
                  additionalProperties:
                    type: string
      responses:
        '202':
          $ref: '#/components/responses/no-content'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/clients/update:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    put:
      operationId: UpdateClientInfo
      summary: Update Client Values
      description: 'Endpoint for clients to update their own information at startup.


        Note: caller must be a client. For users, this endpoint will return a 404 as

        they are not expected or allowed to call this endpoint.

        '
      tags:
      - Clients
      requestBody:
        description: The request body for updating a client
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  type: string
                hostname:
                  type: string
                username:
                  type: string
                version:
                  type: string
                usersid:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/clients/{client_id}:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: client_id
      description: Client ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      operationId: GetClient
      summary: Get Client
      description: Gets given client for processing collection events
      tags:
      - Clients
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client-display'
        '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'
    put:
      operationId: UpdateClient
      summary: Update Client
      description: Update a client for processing collection events
      tags:
      - Clients
      requestBody:
        description: The request body for updating a client
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                domain_controller:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client'
        '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'
    delete:
      operationId: DeleteClient
      summary: Delete Client
      description: Delete a client for processing collection events
      tags:
      - Clients
      responses:
        '200':
          $ref: '#/components/responses/no-content'
        '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/clients/{client_id}/token:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: client_id
      description: Client ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    put:
      operationId: ReplaceClientToken
      summary: Regenerate the authentication token for a client
      description: Regenerate the authentication token for a client
      tags:
      - Clients
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.auth-token'
        '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/clients/{client_id}/completed-tasks:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: client_id
      description: Client ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      operationId: ListClientCompletedTasks
      deprecated: true
      summary: List all completed tasks for a client
      description: '**Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/clients/{client_id}/completed_jobs` instead.

        '
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/query.created-at'
      - $ref: '#/components/parameters/query.updated-at'
      - $ref: '#/components/parameters/query.deleted-at'
      - $ref: '#/components/parameters/query.clients.hydrate-domains'
      - $ref: '#/components/parameters/query.clients.hydrate-ous'
      - $ref: '#/components/parameters/query.skip'
      - $ref: '#/components/parameters/query.limit'
      - name: sort_by
        description: Sortable columns are `event_id`, `execution_time`, `status`, `start_time`, `end_time`, `log_path`, `domain_controller`, `event_title`, `last_ingest`, `id`, `created_at`, `updated_at`, `deleted_at`.
        in: query
        schema:
          $ref: '#/components/schemas/api.params.query.sort-by'
      - name: id
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.integer'
      - $ref: '#/components/parameters/query.clients.job.log-path'
      - $ref: '#/components/parameters/query.clients.job.session-collection'
      - $ref: '#/components/parameters/query.clients.job.local-group-collection'
      - $ref: '#/components/parameters/query.clients.job.cert-services-collection'
      - $ref: '#/components/parameters/query.clients.job.ca-registry-collection'
      - $ref: '#/components/parameters/query.clients.job.dc-registry-collection'
      - $ref: '#/components/parameters/query.clients.job.ad-structure-collection'
      - $ref: '#/components/parameters/query.clients.job.domain-controller'
      - $ref: '#/components/parameters/query.clients.job.status'
      - $ref: '#/components/parameters/query.clients.job.event-title'
      - $ref: '#/components/parameters/query.clients.job.client-id'
      - $ref: '#/components/parameters/query.clients.job.event-id'
      - $ref: '#/components/parameters/query.clients.job.execution-time'
      - $ref: '#/components/parameters/query.clients.job.start-time'
      - $ref: '#/components/parameters/query.clients.job.end-time'
      - $ref: '#/components/parameters/query.clients.job.last-ingest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api.response.pagination'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/model.client-scheduled-job-display'
        '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/clients/{client_id}/completed-jobs:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: client_id
      description: Client ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      operationId: ListClientCompletedJobs
      summary: List all completed jobs for a client
      description: List all completed jobs for a client
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/query.created-at'
      - $ref: '#/components/parameters/query.updated-at'
      - $ref: '#/components/parameters/query.deleted-at'
      - $ref: '#/components/parameters/query.clients.hydrate-domains'
      - $ref: '#/components/parameters/query.clients.hydrate-ous'
      - $ref: '#/components/parameters/query.skip'
      - $ref: '#/components/parameters/query.limit'
      - name: sort_by
        description: Sortable columns are `event_id`, `execution_time`, `status`, `start_time`, `end_time`, `log_path`, `domain_controller`, `event_title`, `last_ingest`, `id`, `created_at`, `updated_at`, `deleted_at`.
        in: query
        schema:
          $ref: '#/components/schemas/api.params.query.sort-by'
      - name: id
        in: query
        schema:
          $ref: '#/components/schemas/api.params.predicate.filter.integer'
      - $ref: '#/components/parameters/query.clients.job.log-path'
      - $ref: '#/components/parameters/query.clients.job.session-collection'
      - $ref: '#/components/parameters/query.clients.job.local-group-collection'
      - $ref: '#/components/parameters/query.clients.job.cert-services-collection'
      - $ref: '#/components/parameters/query.clients.job.ca-registry-collection'
      - $ref: '#/components/parameters/query.clients.job.dc-registry-collection'
      - $ref: '#/components/parameters/query.clients.job.ad-structure-collection'
      - $ref: '#/components/parameters/query.clients.job.domain-controller'
      - $ref: '#/components/parameters/query.clients.job.status'
      - $ref: '#/components/parameters/query.clients.job.event-title'
      - $ref: '#/components/parameters/query.clients.job.client-id'
      - $ref: '#/components/parameters/query.clients.job.event-id'
      - $ref: '#/components/parameters/query.clients.job.execution-time'
      - $ref: '#/components/parameters/query.clients.job.start-time'
      - $ref: '#/components/parameters/query.clients.job.end-time'
      - $ref: '#/components/parameters/query.clients.job.last-ingest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api.response.pagination'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/model.client-scheduled-job-display'
        '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/clients/{client_id}/tasks:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: client_id
      description: Client ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      operationId: CreateClientScheduledTask
      deprecated: true
      summary: Creates a scheduled task
      description: '**Deprecated**: This endpoint will no longer be supported in future releases. Please use `POST /api/v2/clients/{client_id}/jobs` instead.

        '
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/header.prefer'
      requestBody:
        description: The request body for creating a scheduled task
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.client-scheduled-job'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client-scheduled-job'
        '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/clients/{client_id}/jobs:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    - name: client_id
      description: Client ID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      operationId: CreateClientScheduledJob
      summary: Creates a scheduled job
      description: Creates a new scheduled job
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/header.prefer'
      requestBody:
        description: The request body for creating a scheduled job
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.client-scheduled-job'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client-scheduled-job'
        '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/clients/management/start:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    post:
      operationId: StartClientManagementOperation
      summary: Notifies the API of a management operation start
      description: 'Endpoint for clients to start a management operation and mark the start time.


        Note: caller must be a client. For users, this endpoint will return a 403 as

        they are not expected or allowed to call this endpoint.

        '
      tags:
      - Clients
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.client-management-operation-start-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client-management-operation'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.error-wrapper'
              example:
                http_status: 409
                timestamp: '2026-07-01T13:44:43.247Z'
                request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                errors:
                - context: ''
                  message: invalid management operation status transition
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
  /api/v2/clients/management/end:
    parameters:
    - $ref: '#/components/parameters/header.prefer'
    post:
      operationId: EndClientManagementOperation
      summary: Notifies the API of a management operation ending
      description: 'Endpoint for clients to end a management operation and mark the completed time.


        Note: caller must be a client. For users, this endpoint will return a 403 as

        they are not expected or allowed to call this endpoint.

        '
      tags:
      - Clients
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model.client-management-operation-end-request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/model.client-management-operation'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not-found'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.error-wrapper'
              example:
                http_status: 409
                timestamp: '2026-07-01T13:44:43.247Z'
                request_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                errors:
                - context: ''
                  message: invalid management operation status transition
        '429':
          $ref: '#/components/responses/too-many-requests'
        '500':
          $ref: '#/components/responses/internal-server-error'
components:
  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.
    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.
    forbidden:
      description: '**Forbidden**

        This is most commonly caused by an authenticated client trying to

        access a resource that it do

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