Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hoverfly Hoverfly API

Manage Hoverfly runtime configuration.

Hoverfly Hoverfly API is one of 10 APIs that Hoverfly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Hoverfly. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 9 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, http://localhost:8888.

14 operations 9 paths 2 schemas 1 DELETE9 GET4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
http://localhost:8888
License
Resource Areas
1

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 1 DELETE, 9 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Hoverfly 14

Manage Hoverfly runtime configuration.

GET
/api/v2/hoverfly
Get Hoverfly configuration
getHoverfly → 200
GET
/api/v2/hoverfly/cors
Get CORS settings
getCors → 200
GET
/api/v2/hoverfly/destination
Get destination
getDestination → 200
PUT
/api/v2/hoverfly/destination
Set destination
setDestination body → 200
GET
/api/v2/hoverfly/middleware
Get middleware
getMiddleware → 200
PUT
/api/v2/hoverfly/middleware
Update middleware
setMiddleware body → 200
GET
/api/v2/hoverfly/mode
Get mode
getMode → 200
PUT
/api/v2/hoverfly/mode
Set mode
setMode body → 200
GET
/api/v2/hoverfly/version
Get version
getVersion → 200
GET
/api/v2/hoverfly/usage
Get usage metrics
getUsage → 200
GET
/api/v2/hoverfly/upstream-proxy
Get upstream proxy
getUpstreamProxy → 200
GET
/api/v2/hoverfly/pac
Get PAC file
getPac → 200404
PUT
/api/v2/hoverfly/pac
Set PAC file
setPac body → 200
DELETE
/api/v2/hoverfly/pac
Delete PAC file
deletePac → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Middleware (3 properties), Mode (2 properties). Each schema is shown below with its type and property counts.

Mode
object
2 properties
Middleware
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hoverfly-hoverfly-api-openapi.yml Raw ↑

Other APIs Hoverfly publishes across the network.

Hoverfly Cache API
Hoverfly Diff API
Hoverfly Journal API
Hoverfly Logs API
Hoverfly Post-Serve Actions API
Hoverfly Simulation API
Hoverfly State API
Hoverfly System API
Hoverfly Templating Data API