Skip to main content
POST
Create a scenario for a mock

Authorizations

x-api-key
string
header
required

Path Parameters

mock_id
string<uuid>
required

Body

application/json
name
string
required
Required string length: 1 - 255
priority
integer
default:100
Required range: 0 <= x <= 10000
match_method
string
default:ANY
match_path_pattern
string | null
Maximum string length: 1000
match_headers
Match Headers · object
match_query
Match Query · object
match_body
Match Body · object
response_status
integer
default:200
Required range: 100 <= x <= 599
response_headers
Response Headers · object
response_body
delay_ms
integer
default:0
Required range: 0 <= x <= 60000
is_enabled
boolean
default:true

Response

Successful Response

id
string<uuid>
required
mock_id
string<uuid>
required
name
string
required
priority
integer
required
match_method
string
required
match_path_pattern
string | null
required
match_headers
Match Headers · object
required
match_query
Match Query · object
required
match_body
Match Body · object
required
response_status
integer
required
response_headers
Response Headers · object
required
response_body
required
delay_ms
integer
required
is_enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required