Remove requests by criteria

curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/requests/remove \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "POST",
  "url": "/resource",
  "headers": {
    "Content-Type": {
      "matches": ".*/xml"
    }
  }
}
'

{
  "requests": [
    {
      "url": "/my/url",
      "absoluteUrl": "http://mydomain.com/my/url",
      "method": "GET",
      "headers": {
        "Accept-Language": "en-us,en;q=0.5",
        "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:9.0) Gecko/20100101 Firefox/9.0",
        "Accept": "image/png,image/*;q=0.8,*/*;q=0.5"
      },
      "body": "",
      "browserProxyRequest": true,
      "loggedDate": 1339083581823,
      "loggedDateString": "2012-06-07 16:39:41"
    },
    {
      "url": "/my/other/url",
      "absoluteUrl": "http://my.other.domain.com/my/other/url",
      "method": "POST",
      "headers": {
        "Accept": "text/plain",
        "Content-Type": "text/plain"
      },
      "body": "My text",
      "browserProxyRequest": false,
      "loggedDate": 1339083581823,
      "loggedDateString": "2012-06-07 16:39:41"
    }
  ]
}

POST

mock-apis

{mockApiId}

requests

remove

Remove requests by criteria

curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/requests/remove \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "POST",
  "url": "/resource",
  "headers": {
    "Content-Type": {
      "matches": ".*/xml"
    }
  }
}
'

{
  "requests": [
    {
      "url": "/my/url",
      "absoluteUrl": "http://mydomain.com/my/url",
      "method": "GET",
      "headers": {
        "Accept-Language": "en-us,en;q=0.5",
        "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:9.0) Gecko/20100101 Firefox/9.0",
        "Accept": "image/png,image/*;q=0.8,*/*;q=0.5"
      },
      "body": "",
      "browserProxyRequest": true,
      "loggedDate": 1339083581823,
      "loggedDateString": "2012-06-07 16:39:41"
    },
    {
      "url": "/my/other/url",
      "absoluteUrl": "http://my.other.domain.com/my/other/url",
      "method": "POST",
      "headers": {
        "Accept": "text/plain",
        "Content-Type": "text/plain"
      },
      "body": "My text",
      "browserProxyRequest": false,
      "loggedDate": 1339083581823,
      "loggedDateString": "2012-06-07 16:39:41"
    }
  ]
}

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

scheme

enum<string>

The scheme (protocol) part of the request URL

Available options:

http,

https

host

string

The hostname part of the request URL

port

integer

The HTTP port number of the request URL

Required range: 1 <= x <= 65535

method

string

The HTTP request method e.g. GET

url

string

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

urlPath

string

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

urlPathPattern

string

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

urlPattern

string

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

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

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

pathParameters.{key}.equalTo

string

required

pathParameters.{key}.caseInsensitive

boolean

queryParameters

object

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

Show child attributes

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

queryParameters.{key}.equalTo

string

required

queryParameters.{key}.caseInsensitive

boolean

formParameters

object

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

Show child attributes

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

formParameters.{key}.equalTo

string

required

formParameters.{key}.caseInsensitive

boolean

headers

object

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

Show child attributes

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

headers.{key}.equalTo

string

required

headers.{key}.caseInsensitive

boolean

basicAuthCredentials

object

Pre-emptive basic auth credentials to match against

Show child attributes

basicAuthCredentials.password

string

required

basicAuthCredentials.username

string

required

object

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

Show child attributes

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

cookies.{key}.equalTo

string

required

cookies.{key}.caseInsensitive

boolean

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

bodyPatterns.equalTo

string

required

bodyPatterns.caseInsensitive

boolean

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

customMatcher.name

enum<string>

required

Available options:

require-state

customMatcher.parameters

object

required

Show child attributes

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

customMatcher.parameters.requirements.key

string

required

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

customMatcher.parameters.requirements.equalTo

string

required

customMatcher.parameters.requirements.context

string

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

customMatcher.parameters.requirements.caseInsensitive

boolean

multipartPatterns

object[]

Multipart patterns to match against headers and body.

Show child attributes

multipartPatterns.name

string

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

multipartPatterns.headers

object

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

Show child attributes

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

multipartPatterns.headers.{key}.equalTo

string

required

multipartPatterns.headers.{key}.caseInsensitive

boolean

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

multipartPatterns.bodyPatterns.equalTo

string

required

multipartPatterns.bodyPatterns.caseInsensitive

boolean

Response

200 - application/json

Removed request details

Count requests by criteria Delete requests mappings matching metadata

⌘I

Users

Mock APIs

Teams

Organisations

Security

Data sources

Database connections

Usage

Access control

Stub Mappings

Requests

Recordings

State

OpenAPI

Imports

Mock API versioning

Remove requests by criteria

Authorizations

Path Parameters

Body

Response