Delete stub mappings matching metadata

POST

mock-apis

{mockApiId}

mappings

remove-by-metadata

curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/mappings/remove-by-metadata \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "matchesJsonPath": {
    "expression": "$.outer",
    "equalToJson": "{ \"inner\": 42 }"
  }
}'

Authorizations

Authorization

string

header

required

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

Required string length: 5 - 10

Example:

"jjl8y"

Body

application/json

equalTo

string

required

caseInsensitive

boolean

equalTo

string

required

caseInsensitive

boolean

binaryEqualTo

string

required

A base64 encoded string used to describe binary data.

contains

string

required

doesNotContain

string

required

matches

string

required

doesNotMatch

string

required

not

object

required

before

string

required

Example:

"now +3 days"

actualFormat

string

Example:

"yyyy-MM-dd"

truncateExpected

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

truncateActual

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

after

string

required

Example:

"now +3 days"

actualFormat

string

Example:

"yyyy-MM-dd"

truncateExpected

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

truncateActual

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

equalToDateTime

string

required

Example:

"now +3 days"

actualFormat

string

Example:

"yyyy-MM-dd"

truncateExpected

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

truncateActual

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

equalToJson

string

required

Example:

"{ \"message\": \"hello\" }\n"

ignoreExtraElements

boolean

ignoreArrayOrder

boolean

matchesJsonPath

required

Example:

"$.name"

equalToXml

string

required

Example:

"<amount>123</amount>"

enablePlaceholders

boolean

placeholderOpeningDelimiterRegex

string

Example:

"["

placeholderClosingDelimiterRegex

string

Example:

"]"

matchesXPath

required

Example:

"//Order/Amount"

xPathNamespaces

object

matchesJsonSchema

required

Example:

"//Order/Amount"

xPathNamespaces

object

absent

boolean

required

and

object[]

required

object[]

required

hasExactly

object[]

required

includes

object[]

required

Response

200

The stub mappings were successfully removed

Find stub mappings matching metadata Get all requests in journal

curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/mappings/remove-by-metadata \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "matchesJsonPath": {
    "expression": "$.outer",
    "equalToJson": "{ \"inner\": 42 }"
  }
}'

Users

Mock APIs

Teams

Organisations

Security

Data sources

Database connections

Usage

Access control

Stub Mappings

Requests

Recordings

State

OpenAPI

Imports

Delete stub mappings matching metadata

Authorizations

Path Parameters

Body

Response