WireMock

WireMock Recordings API

Stub mapping record and snapshot functions

GitHub OpenAPI

Operations 4

POST /__admin/recordings/start Start Recording
POST /__admin/recordings/stop Stop Recording
GET /__admin/recordings/status Get Recording Status
POST /__admin/recordings/snapshot Take a Snapshot Recording

Documentation

📖
Documentation
https://wiremock.org/docs/standalone/admin-api-reference/

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/wiremock/refs/heads/main/json-schema/wiremock-stub-mapping-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/wiremock/refs/heads/main/json-structure/wiremock-stub-mapping-structure.json

Other Resources

🔗
Rules
https://raw.githubusercontent.com/api-evangelist/wiremock/refs/heads/main/rules/wiremock-rules.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/wiremock/refs/heads/main/capabilities/api-mocking-and-testing.yaml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/wiremock/refs/heads/main/examples/wiremock-create-stub-mapping-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/wiremock/refs/heads/main/examples/wiremock-scenario-stub-example.json

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/wiremock-recordings-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

wiremock-recordings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: WireMock Admin Near Misses Recordings API
  description: The WireMock Admin REST API provides programmatic control over a running WireMock server instance. It supports creating, updating, and deleting stub mappings; querying the request journal; recording and replaying real API traffic; managing stateful scenarios; and performing system operations such as reset and shutdown. Available under the /__admin/ path prefix on any running WireMock instance.
  version: 2.35.0
  contact:
    name: WireMock Community
    url: https://wiremock.org/
servers:
- url: http://localhost:8080
  description: Local WireMock server instance
tags:
- name: Recordings
  description: Stub mapping record and snapshot functions
  externalDocs:
    description: User documentation
    url: http://wiremock.org/docs/record-playback/
paths:
  /__admin/recordings/start:
    post:
      summary: Start Recording
      description: Begin recording stub mappings
      tags:
      - Recordings
      requestBody:
        $ref: '#/components/requestBodies/startRecording'
      responses:
        '200':
          description: Successfully started recording
  /__admin/recordings/stop:
    post:
      summary: Stop Recording
      description: End recording of stub mappings
      tags:
      - Recordings
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: schemas/stub-mappings.yaml
              example:
                $ref: examples/recorded-stub-mappings.yaml
          description: Successfully stopped recording
  /__admin/recordings/status:
    get:
      summary: Get Recording Status
      tags:
      - Recordings
      responses:
        '200':
          description: Successfully got the record status
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: Stopped
                    enum:
                    - NeverStarted
                    - Recording
                    - Stopped
  /__admin/recordings/snapshot:
    post:
      summary: Take a Snapshot Recording
      tags:
      - Recordings
      requestBody:
        $ref: '#/components/requestBodies/snapshotRecording'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: schemas/stub-mappings.yaml
              example:
                $ref: examples/recorded-stub-mappings.yaml
          description: Successfully took a snapshot recording
components:
  requestBodies:
    snapshotRecording:
      required: true
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: schemas/record-spec.yaml
            - properties:
                filters:
                  type: object
                  allOf:
                  - properties:
                      ids:
                        type: array
                        items:
                          type: string
                    type: object
                    description: Filter requests for which to create stub mapping
                  - $ref: schemas/request-pattern.yaml
          example:
            $ref: examples/snapshot-spec.yaml
    startRecording:
      required: true
      content:
        application/json:
          schema:
            allOf:
            - $ref: schemas/record-spec.yaml
            - properties:
                filters:
                  allOf:
                  - $ref: schemas/request-pattern.yaml
                  - description: Filter requests for which to create stub mapping
                targetBaseUrl:
                  type: string
                  description: Target URL when using the record and playback API
                  example: http://examples.wiremockapi.cloud/
          example:
            $ref: examples/record-spec.yaml
externalDocs:
  description: WireMock User Documentation
  url: https://wiremock.org/docs/