Skip to main content
POST
/
v1
/
mock-apis
/
{mockApiId}
/
recordings
/
snapshot
Take a snapshot recording
curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "urlPathPattern": "/api/.*",
    "method": "GET",
    "ids": [
      "40a93c4a-d378-4e07-8321-6158d5dbcb29"
    ]
  },
  "captureHeaders": {
    "Accept": {},
    "Content-Type": {
      "caseInsensitive": true
    }
  },
  "requestBodyPattern": {
    "matcher": "equalToJson",
    "ignoreArrayOrder": false,
    "ignoreExtraElements": true
  },
  "extractBodyCriteria": {
    "textSizeThreshold": "2 kb",
    "binarySizeThreshold": "1 Mb"
  },
  "outputFormat": "FULL",
  "persist": false,
  "repeatsAsScenarios": false,
  "transformers": [
    "modify-response-header"
  ],
  "transformerParameters": {
    "headerValue": "123"
  }
}
'
import requests

url = "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot"

payload = {
    "filters": {
        "urlPathPattern": "/api/.*",
        "method": "GET",
        "ids": ["40a93c4a-d378-4e07-8321-6158d5dbcb29"]
    },
    "captureHeaders": {
        "Accept": {},
        "Content-Type": { "caseInsensitive": True }
    },
    "requestBodyPattern": {
        "matcher": "equalToJson",
        "ignoreArrayOrder": False,
        "ignoreExtraElements": True
    },
    "extractBodyCriteria": {
        "textSizeThreshold": "2 kb",
        "binarySizeThreshold": "1 Mb"
    },
    "outputFormat": "FULL",
    "persist": False,
    "repeatsAsScenarios": False,
    "transformers": ["modify-response-header"],
    "transformerParameters": { "headerValue": "123" }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: {
      urlPathPattern: '/api/.*',
      method: 'GET',
      ids: ['40a93c4a-d378-4e07-8321-6158d5dbcb29']
    },
    captureHeaders: {Accept: {}, 'Content-Type': {caseInsensitive: true}},
    requestBodyPattern: {matcher: 'equalToJson', ignoreArrayOrder: false, ignoreExtraElements: true},
    extractBodyCriteria: {textSizeThreshold: '2 kb', binarySizeThreshold: '1 Mb'},
    outputFormat: 'FULL',
    persist: false,
    repeatsAsScenarios: false,
    transformers: ['modify-response-header'],
    transformerParameters: {headerValue: '123'}
  })
};

fetch('https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        'urlPathPattern' => '/api/.*',
        'method' => 'GET',
        'ids' => [
                '40a93c4a-d378-4e07-8321-6158d5dbcb29'
        ]
    ],
    'captureHeaders' => [
        'Accept' => [
                
        ],
        'Content-Type' => [
                'caseInsensitive' => true
        ]
    ],
    'requestBodyPattern' => [
        'matcher' => 'equalToJson',
        'ignoreArrayOrder' => false,
        'ignoreExtraElements' => true
    ],
    'extractBodyCriteria' => [
        'textSizeThreshold' => '2 kb',
        'binarySizeThreshold' => '1 Mb'
    ],
    'outputFormat' => 'FULL',
    'persist' => false,
    'repeatsAsScenarios' => false,
    'transformers' => [
        'modify-response-header'
    ],
    'transformerParameters' => [
        'headerValue' => '123'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot"

	payload := strings.NewReader("{\n  \"filters\": {\n    \"urlPathPattern\": \"/api/.*\",\n    \"method\": \"GET\",\n    \"ids\": [\n      \"40a93c4a-d378-4e07-8321-6158d5dbcb29\"\n    ]\n  },\n  \"captureHeaders\": {\n    \"Accept\": {},\n    \"Content-Type\": {\n      \"caseInsensitive\": true\n    }\n  },\n  \"requestBodyPattern\": {\n    \"matcher\": \"equalToJson\",\n    \"ignoreArrayOrder\": false,\n    \"ignoreExtraElements\": true\n  },\n  \"extractBodyCriteria\": {\n    \"textSizeThreshold\": \"2 kb\",\n    \"binarySizeThreshold\": \"1 Mb\"\n  },\n  \"outputFormat\": \"FULL\",\n  \"persist\": false,\n  \"repeatsAsScenarios\": false,\n  \"transformers\": [\n    \"modify-response-header\"\n  ],\n  \"transformerParameters\": {\n    \"headerValue\": \"123\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {\n    \"urlPathPattern\": \"/api/.*\",\n    \"method\": \"GET\",\n    \"ids\": [\n      \"40a93c4a-d378-4e07-8321-6158d5dbcb29\"\n    ]\n  },\n  \"captureHeaders\": {\n    \"Accept\": {},\n    \"Content-Type\": {\n      \"caseInsensitive\": true\n    }\n  },\n  \"requestBodyPattern\": {\n    \"matcher\": \"equalToJson\",\n    \"ignoreArrayOrder\": false,\n    \"ignoreExtraElements\": true\n  },\n  \"extractBodyCriteria\": {\n    \"textSizeThreshold\": \"2 kb\",\n    \"binarySizeThreshold\": \"1 Mb\"\n  },\n  \"outputFormat\": \"FULL\",\n  \"persist\": false,\n  \"repeatsAsScenarios\": false,\n  \"transformers\": [\n    \"modify-response-header\"\n  ],\n  \"transformerParameters\": {\n    \"headerValue\": \"123\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {\n    \"urlPathPattern\": \"/api/.*\",\n    \"method\": \"GET\",\n    \"ids\": [\n      \"40a93c4a-d378-4e07-8321-6158d5dbcb29\"\n    ]\n  },\n  \"captureHeaders\": {\n    \"Accept\": {},\n    \"Content-Type\": {\n      \"caseInsensitive\": true\n    }\n  },\n  \"requestBodyPattern\": {\n    \"matcher\": \"equalToJson\",\n    \"ignoreArrayOrder\": false,\n    \"ignoreExtraElements\": true\n  },\n  \"extractBodyCriteria\": {\n    \"textSizeThreshold\": \"2 kb\",\n    \"binarySizeThreshold\": \"1 Mb\"\n  },\n  \"outputFormat\": \"FULL\",\n  \"persist\": false,\n  \"repeatsAsScenarios\": false,\n  \"transformers\": [\n    \"modify-response-header\"\n  ],\n  \"transformerParameters\": {\n    \"headerValue\": \"123\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "mappings": [
    {
      "id": "093f1027-e5e0-4921-9e6d-e619dfd5d2c7",
      "name": "recordables_123",
      "request": {
        "url": "/recordables/123",
        "method": "GET"
      },
      "response": {
        "status": 200,
        "body": "{\n  \"message\": \"Congratulations on your first recording!\"\n}",
        "headers": {
          "Content-Type": "application/json"
        }
      },
      "uuid": "093f1027-e5e0-4921-9e6d-e619dfd5d2c7",
      "persistent": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your API key prefixed by 'Token '

Path Parameters

​
mockApiId
string
required

The ID of the Mock API

Required string length: 5 - 10
Example:

"jjl8y"

Body

application/json
​
captureHeaders
object

Headers from the request to include in the generated stub mappings, mapped to parameter objects. The only parameter available is "caseInsensitive", which defaults to false

Example:
{
  "Accept": {},
  "Content-Type": { "caseInsensitive": true }
}
​
extractBodyCriteria
object

Criteria for extracting response bodies to a separate file instead of including it in the stub mapping

Example:
{
  "binarySizeThreshold": "1 Mb",
  "textSizeThreshold": "2 kb"
}
​
persist
boolean
default:true

Whether to save stub mappings to the file system or just return them

​
repeatsAsScenarios
boolean
default:true

When true, duplicate requests will be added to a Scenario. When false, duplicates are discarded

​
requestBodyPattern
object

Automatically determine matcher based on content type (the default)

​
transformerParameters
object

List of names of stub mappings transformers to apply to generated stubs

​
transformers
string[]

Parameters to pass to stub mapping transformers

​
filters
object

Filter requests for which to create stub mapping

Example:

"{\n \"urlPath\" : \"/charges\",\n \"method\" : \"POST\",\n \"headers\" : {\n \"Content-Type\" : {\n \"equalTo\" : \"application/json\"\n }\n }\n"

Response

200 - application/json

Successfully took a snapshot recording

​
mappings
object[]
​
meta
object