Start recording

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

Show child attributes

captureHeaders.{key}

object

Show child attributes

captureHeaders.{key}.caseInsensitive

boolean

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

Show child attributes

extractBodyCriteria.binarySizeThreshold

string

default:0

Size threshold for extracting binary response bodies. Supports humanized size strings, e.g. "56 Mb". Default unit is bytes.

Example:

"18.2 GB"

extractBodyCriteria.textSizeThreshold

string

default:0

Size threshold for extracting binary response bodies. Supports humanized size strings, e.g. "56 Mb". Default unit is bytes.

Example:

"18.2 GB"

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

Control the request body matcher used in generated stub mappings Automatically determine matcher based on content type (the default)

Option 1
Option 2
Option 3
Option 4

Show child attributes

requestBodyPattern.caseInsensitive

boolean

default:false

If equalTo is used, match body use case-insensitive string comparison

requestBodyPattern.ignoreArrayOrder

boolean

default:true

If equalToJson is used, ignore order of array elements

requestBodyPattern.ignoreExtraElements

boolean

default:true

If equalToJson is used, matcher ignores extra elements in objects

requestBodyPattern.matcher

enum<string>

Available options:

auto

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

Show child attributes

filters.scheme

enum<string>

The scheme (protocol) part of the request URL

Available options:

http,

https

filters.host

string

The hostname part of the request URL

filters.port

integer

The HTTP port number of the request URL

Required range: 1 <= x <= 65535

filters.method

string

The HTTP request method e.g. GET

filters.url

string

The path and query to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

filters.urlPath

string

The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

filters.urlPathPattern

string

The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

filters.urlPattern

string

The path and query regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

filters.pathParameters

object

Path parameter patterns to match against in the : { "": "" } form. Can only be used when the urlPathPattern URL match type is in use and all keys must be present as variables in the path template.

Show child attributes

filters.pathParameters.{key}

Content pattern · object

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.pathParameters.{key}.equalTo

string

required

filters.pathParameters.{key}.caseInsensitive

boolean

filters.queryParameters

object

Query parameter patterns to match against in the : { "": "" } form

Show child attributes

filters.queryParameters.{key}

Content pattern · object

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.queryParameters.{key}.equalTo

string

required

filters.queryParameters.{key}.caseInsensitive

boolean

filters.formParameters

object

application/x-www-form-urlencoded form parameter patterns to match against in the : { "": "" } form

Show child attributes

filters.formParameters.{key}

Content pattern · object

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.formParameters.{key}.equalTo

string

required

filters.formParameters.{key}.caseInsensitive

boolean

filters.headers

object

Header patterns to match against in the : { "": "" } form

Show child attributes

filters.headers.{key}

Content pattern · object

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.headers.{key}.equalTo

string

required

filters.headers.{key}.caseInsensitive

boolean

filters.basicAuthCredentials

object

Pre-emptive basic auth credentials to match against

Show child attributes

filters.basicAuthCredentials.password

string

required

filters.basicAuthCredentials.username

string

required

filters.cookies

object

Cookie patterns to match against in the : { "": "" } form

Show child attributes

filters.cookies.{key}

Content pattern · object

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.cookies.{key}.equalTo

string

required

filters.cookies.{key}.caseInsensitive

boolean

filters.bodyPatterns

Content pattern · object[]

Request body patterns to match against in the : { "": "" } form

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.bodyPatterns.equalTo

string

required

filters.bodyPatterns.caseInsensitive

boolean

filters.customMatcher

Dynamic State Matcher · object

Require the state of the Mock API to match the provided patterns. More information on this feature can be found here.

Dynamic State Matcher
Data Source Matcher

Show child attributes

filters.customMatcher.name

enum<string>

required

Available options:

require-state

filters.customMatcher.parameters

object

required

Show child attributes

filters.customMatcher.parameters.requirements

Content pattern · object[]

required

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.customMatcher.parameters.requirements.key

string

required

The key of the item to match. Cannot be templated.

filters.customMatcher.parameters.requirements.equalTo

string

required

filters.customMatcher.parameters.requirements.context

string

The context of the item to match. Can be templated.

filters.customMatcher.parameters.requirements.caseInsensitive

boolean

filters.multipartPatterns

object[]

Multipart patterns to match against headers and body.

Show child attributes

filters.multipartPatterns.name

string

filters.multipartPatterns.matchingType

enum<string>

default:ANY

Determines whether all or any of the parts must match the criteria for an overall match.

Available options:

ALL,

ANY

filters.multipartPatterns.headers

object

Header patterns to match against in the : { "": "" } form

Show child attributes

filters.multipartPatterns.headers.{key}

Content pattern · object

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.multipartPatterns.headers.{key}.equalTo

string

required

filters.multipartPatterns.headers.{key}.caseInsensitive

boolean

filters.multipartPatterns.bodyPatterns

Content pattern · object[]

Body patterns to match against in the : { "": "" } form

Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern
Content pattern

Show child attributes

filters.multipartPatterns.bodyPatterns.equalTo

string

required

filters.multipartPatterns.bodyPatterns.caseInsensitive

boolean

Example:

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

targetBaseUrl

string

Target URL when using the record and playback API

Example:

"https://example.wiremock.org"

Response

200

Successfully started recording

Users

Mock APIs

Teams

Organisations

Security

Data sources

Database connections

Usage

Access control

Stub Mappings

Requests

Recordings

State

OpenAPI

Imports

Mock API versioning

Authorizations

Path Parameters

Body

Response