POST
/
v1
/
mock-apis
/
{mockApiId}
/
recordings
/
snapshot

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

mockApiId
string
required

The ID of the Mock API

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

extractBodyCriteria
object

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

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

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

Response

200 - application/json
mappings
object[]
meta
object