Hoverfly

Hoverfly Hoverfly API

Manage Hoverfly runtime configuration.

GitHub OpenAPI

Operations 14

GET /api/v2/hoverfly Get Hoverfly configuration #
GET /api/v2/hoverfly/cors Get CORS settings #
GET /api/v2/hoverfly/destination Get destination #
PUT /api/v2/hoverfly/destination Set destination #
GET /api/v2/hoverfly/middleware Get middleware #
PUT /api/v2/hoverfly/middleware Update middleware #
GET /api/v2/hoverfly/mode Get mode #
PUT /api/v2/hoverfly/mode Set mode #
GET /api/v2/hoverfly/version Get version #
GET /api/v2/hoverfly/usage Get usage metrics #
GET /api/v2/hoverfly/upstream-proxy Get upstream proxy #
GET /api/v2/hoverfly/pac Get PAC file #
PUT /api/v2/hoverfly/pac Set PAC file #
DELETE /api/v2/hoverfly/pac Delete PAC file #

Documentation

📖
Documentation
https://docs.hoverfly.io
📖
APIReference
https://docs.hoverfly.io/en/latest/pages/reference/api/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hoverfly/refs/heads/main/openapi/hoverfly-hoverfly-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/SpectoLabs/hoverfly

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/hoverfly-hoverfly-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

hoverfly-hoverfly-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Admin Cache Hoverfly API
  description: Hoverfly's Admin API provides programmatic control of a Hoverfly instance, including simulation management, mode and middleware configuration, journal and diff inspection, state management, caching, logging, templating data sources, and post-serve actions.
  version: '2.0'
  contact:
    name: Hoverfly Project
    url: https://docs.hoverfly.io
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8888
  description: Default Hoverfly Admin API endpoint
tags:
- name: Hoverfly
  description: Manage Hoverfly runtime configuration.
paths:
  /api/v2/hoverfly:
    get:
      tags:
      - Hoverfly
      summary: Get Hoverfly configuration
      operationId: getHoverfly
      responses:
        '200':
          description: Configuration.
          content:
            application/json:
              schema:
                type: object
  /api/v2/hoverfly/cors:
    get:
      tags:
      - Hoverfly
      summary: Get CORS settings
      operationId: getCors
      responses:
        '200':
          description: CORS settings.
          content:
            application/json:
              schema:
                type: object
  /api/v2/hoverfly/destination:
    get:
      tags:
      - Hoverfly
      summary: Get destination
      operationId: getDestination
      responses:
        '200':
          description: Destination.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destination:
                    type: string
    put:
      tags:
      - Hoverfly
      summary: Set destination
      operationId: setDestination
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - destination
              properties:
                destination:
                  type: string
      responses:
        '200':
          description: Destination updated.
  /api/v2/hoverfly/middleware:
    get:
      tags:
      - Hoverfly
      summary: Get middleware
      operationId: getMiddleware
      responses:
        '200':
          description: Middleware configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Middleware'
    put:
      tags:
      - Hoverfly
      summary: Update middleware
      operationId: setMiddleware
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Middleware'
      responses:
        '200':
          description: Middleware updated.
  /api/v2/hoverfly/mode:
    get:
      tags:
      - Hoverfly
      summary: Get mode
      operationId: getMode
      responses:
        '200':
          description: Mode.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mode'
    put:
      tags:
      - Hoverfly
      summary: Set mode
      operationId: setMode
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Mode'
      responses:
        '200':
          description: Mode updated.
  /api/v2/hoverfly/version:
    get:
      tags:
      - Hoverfly
      summary: Get version
      operationId: getVersion
      responses:
        '200':
          description: Version.
          content:
            application/json:
              schema:
                type: object
  /api/v2/hoverfly/usage:
    get:
      tags:
      - Hoverfly
      summary: Get usage metrics
      operationId: getUsage
      responses:
        '200':
          description: Usage metrics.
          content:
            application/json:
              schema:
                type: object
  /api/v2/hoverfly/upstream-proxy:
    get:
      tags:
      - Hoverfly
      summary: Get upstream proxy
      operationId: getUpstreamProxy
      responses:
        '200':
          description: Upstream proxy.
          content:
            application/json:
              schema:
                type: object
  /api/v2/hoverfly/pac:
    get:
      tags:
      - Hoverfly
      summary: Get PAC file
      operationId: getPac
      responses:
        '200':
          description: PAC file.
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: PAC not configured.
    put:
      tags:
      - Hoverfly
      summary: Set PAC file
      operationId: setPac
      requestBody:
        required: true
        content:
          text/plain:
            schema:
              type: string
      responses:
        '200':
          description: PAC set.
    delete:
      tags:
      - Hoverfly
      summary: Delete PAC file
      operationId: deletePac
      responses:
        '200':
          description: PAC removed.
components:
  schemas:
    Middleware:
      type: object
      properties:
        binary:
          type: string
        script:
          type: string
        remote:
          type: string
    Mode:
      type: object
      properties:
        mode:
          type: string
          enum:
          - simulate
          - capture
          - modify
          - synthesize
          - spy
          - diff
        arguments:
          type: object
externalDocs:
  description: Hoverfly Admin API Reference
  url: https://docs.hoverfly.io/en/latest/pages/reference/api/api.html