Mock APIs
Create a new mock API
Mock APIs
Teams
Organisations
Data sources
Database connections
Usage
Access control
Stub Mappings
- GETGet all stub mappings
- POSTCreate a new stub mapping
- DELDelete all stub mappings
- POSTReset stub mappings
- POSTPersist stub mappings
- POSTImport stub mappings
- GETGet stub mapping by ID
- PUTUpdate a stub mapping
- DELDelete a stub mapping
- POSTFind stub mappings matching metadata
- POSTDelete stub mappings matching metadata
Requests
Mock APIs
Create a new mock API
POST
/
v1
/
mock-apis
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
username
string
username
string
password
string
password
string
object
mockApi
object
mockApi
object
name
string
*
name
Required
string
The display name of the mock API.
apiTemplateId
string
apiTemplateId
string
The ID of the API template from which to derive this mock API. The mock API will be blank if this is not specified.
type
enum<string>
type
enum<string>
The type of the mock API. Defaults to the "unstructured" type if not specified.
hostname
string
hostname
string
The friendly, unqualified domain name for this mock API's base URL
e.g. in the SaaS edition, for a base URL of https://my-api.wiremockapi.cloud this value should be set to my-api.
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
mockApi
object
Response
201 - application/json
mockApi
object
required