Mock APIs
Get mock API by ID
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
Mock APIs
Get mock API by ID
GET
/
v1
/
mock-apis
/
{mockApiId}
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
mockApiId
string
*
mockApiId
Required
string
The ID of the Mock API
Add Example Value
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The ID of the Mock API
Required string length:
5 - 10Response
200 - application/json
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.
Available options:
openapi, grpc