Start recording
curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/start \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"targetBaseUrl": "http://example.mocklab.io",
"filters": {
"urlPathPattern": "/api/.*",
"method": "GET"
},
"captureHeaders": {
"Accept": {},
"Content-Type": {
"caseInsensitive": true
}
},
"requestBodyPattern": {
"matcher": "equalToJson",
"ignoreArrayOrder": false,
"ignoreExtraElements": true
},
"extractBodyCriteria": {
"textSizeThreshold": "2048",
"binarySizeThreshold": "10240"
},
"persist": false,
"repeatsAsScenarios": false,
"transformers": [
"modify-response-header"
],
"transformerParameters": {
"headerValue": "123"
}
}
'import requests
url = "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/start"
payload = {
"targetBaseUrl": "http://example.mocklab.io",
"filters": {
"urlPathPattern": "/api/.*",
"method": "GET"
},
"captureHeaders": {
"Accept": {},
"Content-Type": { "caseInsensitive": True }
},
"requestBodyPattern": {
"matcher": "equalToJson",
"ignoreArrayOrder": False,
"ignoreExtraElements": True
},
"extractBodyCriteria": {
"textSizeThreshold": "2048",
"binarySizeThreshold": "10240"
},
"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({
targetBaseUrl: 'http://example.mocklab.io',
filters: {urlPathPattern: '/api/.*', method: 'GET'},
captureHeaders: {Accept: {}, 'Content-Type': {caseInsensitive: true}},
requestBodyPattern: {matcher: 'equalToJson', ignoreArrayOrder: false, ignoreExtraElements: true},
extractBodyCriteria: {textSizeThreshold: '2048', binarySizeThreshold: '10240'},
persist: false,
repeatsAsScenarios: false,
transformers: ['modify-response-header'],
transformerParameters: {headerValue: '123'}
})
};
fetch('https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/start', 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/start",
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([
'targetBaseUrl' => 'http://example.mocklab.io',
'filters' => [
'urlPathPattern' => '/api/.*',
'method' => 'GET'
],
'captureHeaders' => [
'Accept' => [
],
'Content-Type' => [
'caseInsensitive' => true
]
],
'requestBodyPattern' => [
'matcher' => 'equalToJson',
'ignoreArrayOrder' => false,
'ignoreExtraElements' => true
],
'extractBodyCriteria' => [
'textSizeThreshold' => '2048',
'binarySizeThreshold' => '10240'
],
'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/start"
payload := strings.NewReader("{\n \"targetBaseUrl\": \"http://example.mocklab.io\",\n \"filters\": {\n \"urlPathPattern\": \"/api/.*\",\n \"method\": \"GET\"\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\": \"2048\",\n \"binarySizeThreshold\": \"10240\"\n },\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/start")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetBaseUrl\": \"http://example.mocklab.io\",\n \"filters\": {\n \"urlPathPattern\": \"/api/.*\",\n \"method\": \"GET\"\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\": \"2048\",\n \"binarySizeThreshold\": \"10240\"\n },\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/start")
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 \"targetBaseUrl\": \"http://example.mocklab.io\",\n \"filters\": {\n \"urlPathPattern\": \"/api/.*\",\n \"method\": \"GET\"\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\": \"2048\",\n \"binarySizeThreshold\": \"10240\"\n },\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_bodyRecordings
Start recording
Begin recording stub mappings
POST
/
v1
/
mock-apis
/
{mockApiId}
/
recordings
/
start
Start recording
curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/start \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"targetBaseUrl": "http://example.mocklab.io",
"filters": {
"urlPathPattern": "/api/.*",
"method": "GET"
},
"captureHeaders": {
"Accept": {},
"Content-Type": {
"caseInsensitive": true
}
},
"requestBodyPattern": {
"matcher": "equalToJson",
"ignoreArrayOrder": false,
"ignoreExtraElements": true
},
"extractBodyCriteria": {
"textSizeThreshold": "2048",
"binarySizeThreshold": "10240"
},
"persist": false,
"repeatsAsScenarios": false,
"transformers": [
"modify-response-header"
],
"transformerParameters": {
"headerValue": "123"
}
}
'import requests
url = "https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/start"
payload = {
"targetBaseUrl": "http://example.mocklab.io",
"filters": {
"urlPathPattern": "/api/.*",
"method": "GET"
},
"captureHeaders": {
"Accept": {},
"Content-Type": { "caseInsensitive": True }
},
"requestBodyPattern": {
"matcher": "equalToJson",
"ignoreArrayOrder": False,
"ignoreExtraElements": True
},
"extractBodyCriteria": {
"textSizeThreshold": "2048",
"binarySizeThreshold": "10240"
},
"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({
targetBaseUrl: 'http://example.mocklab.io',
filters: {urlPathPattern: '/api/.*', method: 'GET'},
captureHeaders: {Accept: {}, 'Content-Type': {caseInsensitive: true}},
requestBodyPattern: {matcher: 'equalToJson', ignoreArrayOrder: false, ignoreExtraElements: true},
extractBodyCriteria: {textSizeThreshold: '2048', binarySizeThreshold: '10240'},
persist: false,
repeatsAsScenarios: false,
transformers: ['modify-response-header'],
transformerParameters: {headerValue: '123'}
})
};
fetch('https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/start', 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/start",
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([
'targetBaseUrl' => 'http://example.mocklab.io',
'filters' => [
'urlPathPattern' => '/api/.*',
'method' => 'GET'
],
'captureHeaders' => [
'Accept' => [
],
'Content-Type' => [
'caseInsensitive' => true
]
],
'requestBodyPattern' => [
'matcher' => 'equalToJson',
'ignoreArrayOrder' => false,
'ignoreExtraElements' => true
],
'extractBodyCriteria' => [
'textSizeThreshold' => '2048',
'binarySizeThreshold' => '10240'
],
'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/start"
payload := strings.NewReader("{\n \"targetBaseUrl\": \"http://example.mocklab.io\",\n \"filters\": {\n \"urlPathPattern\": \"/api/.*\",\n \"method\": \"GET\"\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\": \"2048\",\n \"binarySizeThreshold\": \"10240\"\n },\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/start")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetBaseUrl\": \"http://example.mocklab.io\",\n \"filters\": {\n \"urlPathPattern\": \"/api/.*\",\n \"method\": \"GET\"\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\": \"2048\",\n \"binarySizeThreshold\": \"10240\"\n },\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/start")
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 \"targetBaseUrl\": \"http://example.mocklab.io\",\n \"filters\": {\n \"urlPathPattern\": \"/api/.*\",\n \"method\": \"GET\"\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\": \"2048\",\n \"binarySizeThreshold\": \"10240\"\n },\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_bodyPath Parameters
The ID of the Mock API
Required string length:
5 - 10Example:
"jjl8y"
Body
application/json
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
Show child attributes
Show child attributes
Example:
{ "Accept": {}, "Content-Type": { "caseInsensitive": true } }
Criteria for extracting response bodies to a separate file instead of including it in the stub mapping
Show child attributes
Show child attributes
Example:
{ "binarySizeThreshold": "1 Mb", "textSizeThreshold": "2 kb" }
Whether to save stub mappings to the file system or just return them
When true, duplicate requests will be added to a Scenario. When false, duplicates are discarded
Automatically determine matcher based on content type (the default)
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
List of names of stub mappings transformers to apply to generated stubs
Parameters to pass to stub mapping transformers
Filter requests for which to create stub mapping
Show child attributes
Show child attributes
Example:
"{\n \"urlPath\" : \"/charges\",\n \"method\" : \"POST\",\n \"headers\" : {\n \"Content-Type\" : {\n \"equalTo\" : \"application/json\"\n }\n }\n"
Target URL when using the record and playback API
Example:
"https://example.wiremock.org"
Response
200
Successfully started recording
⌘I