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

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

Body

application/json
basicAuthCredentials
object

Pre-emptive basic auth credentials to match against

bodyPatterns
object[]

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

cookies
object

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

customMatcher
object

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

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

host
string

The hostname part of the request URL

method
string

The HTTP request method e.g. GET

multipartPatterns
object[]

Multipart patterns to match against headers and body.

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.

port
integer

The HTTP port number of the request URL

Required range: 1 < x < 65535
queryParameters
object

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

scheme
enum<string>

The scheme (protocol) part of the request URL

Available options:
http,
https
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.

Response

200 - application/json

The response is of type any.