Hoverfly

Hoverfly System API

System-level controls.

GitHub OpenAPI

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-system-api-openapi.yml

Other Resources

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

OpenAPI Specification

hoverfly-system-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Hoverfly Admin Cache System 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: System
  description: System-level controls.
paths:
  /api/v2/shutdown:
    delete:
      tags:
      - System
      summary: Shut down Hoverfly
      operationId: shutdown
      responses:
        '200':
          description: Hoverfly shutting down.
externalDocs:
  description: Hoverfly Admin API Reference
  url: https://docs.hoverfly.io/en/latest/pages/reference/api/api.html