POST
/
v1
/
mock-apis
/
{mockApiId}
/
requests
/
find

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
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

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 <key>: { "<predicate>": "<value>" } 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.

queryParameters
object

Query parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form

formParameters
object

application/x-www-form-urlencoded form parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form

headers
object

Header patterns to match against in the <key>: { "<predicate>": "<value>" } form

basicAuthCredentials
object

Pre-emptive basic auth credentials to match against

cookies
object

Cookie patterns to match against in the <key>: { "<predicate>": "<value>" } form

bodyPatterns
object[]

Request body patterns to match against in the <key>: { "<predicate>": "<value>" } form

customMatcher
object

Custom request matcher to match against

multipartPatterns
object[]

Multipart patterns to match against headers and body.

Response

200 - application/json

The response is of type any.

Delete requests mappings matching metadataFind unmatched requests