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
OpenAPI
Imports
Create a new mock API
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
The display name of the mock API.
The ID of the API template from which to derive this mock API. The mock API will be blank if this is not specified.
The type of the mock API. Defaults to the "unstructured" type if not specified.
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
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The display name of the mock API.
The ID of the API template from which to derive this mock API. The mock API will be blank if this is not specified.
The type of the mock API. Defaults to the "unstructured" type if not specified.
openapi, grpc 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.
Response
The display name of the mock API.
Whether the API is running or stopped.
Whether security is enabled on the mock API's /__admin/* endpoints.
The link to the access control list for this mock API.
The list of domain names that can be used to address this mock API.
The type of the mock API. Defaults to the "unstructured" type if not specified.
openapi, grpc