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
- GETGet all requests in journal
- DELDelete all requests in journal
- GETGet request by ID
- DELDelete request by ID
- POSTEmpty the request journaldeprecated
- POSTCount requests by criteria
- POSTRemove requests by criteria
- POSTDelete requests mappings matching metadata
- POSTFind requests by criteria
- GETFind unmatched requests
OpenAPI
Imports
Mock APIs
Get mock APIs accessible to a user
GET
/
v1
/
users
/
{userId}
/
apis
curl --request GET \
--url https://wmc.wiremockapi.cloud/v1/users/{userId}/apis \
--header 'Authorization: Basic <encoded-value>'
{
"links": {
"self": "/v1/users/9gd5l/apis?limit=20&page=1"
},
"meta": {
"start": 1,
"end": 1,
"total": 1,
"page": 1,
"totalPages": 1
},
"mockApis": [
{
"id": "63om1",
"aclObject": "1z6rd",
"name": "Example Mock API",
"description": "An API consisting of assorted stubs.",
"state": "RUNNING",
"adminSecurityEnabled": true,
"exportState": "EXPORT_ALLOWED",
"createdDate": "2024-08-23T20:15:32.432385Z",
"openApiGitIntegration": "63om1-openapi-integration-git",
"links": {
"self": "/v1/mock-apis/63om1",
"requests": "/v1/mock-apis/63om1/requests",
"mappings": "/v1/mock-apis/63om1/mappings",
"scenarios": "/v1/mock-apis/63om1/scenarios",
"recordings": {
"start": "/v1/mock-apis/63om1/recordings/start",
"stop": "/v1/mock-apis/63om1/recordings/stop",
"status": "/v1/mock-apis/63om1/recordings/status",
"snapshot": "/v1/mock-apis/63om1/recordings/snapshot"
},
"imports": "/v1/mock-apis/63om1/imports",
"organisation": "/v1/organisations/mgk7g",
"aclObject": "/v1/acl/objects/1z6rd",
"aclRoles": "/v1/acl/objects/1z6rd/roles",
"invitations": "/v1/mock-apis/63om1/invitations",
"acl": "/v1/mock-apis/63om1/acl{?subjectId}"
},
"baseUrl": "https://63om1.wiremockapi.cloud",
"domainNames": [
{
"domainName": "63om1.wiremockapi.cloud",
"urls": [
{
"url": "https://63om1.wiremockapi.cloud"
},
{
"url": "http://63om1.wiremockapi.cloud"
}
]
}
],
"domains": [
"63om1.wiremockapi.cloud"
]
}
],
"aclObjects": [
{
"id": "1z6rd",
"objectType": "mock-api",
"name": "Example Mock API",
"aclGrants": [
"9gd5l-1z6rd-mock_api_admin"
],
"links": {
"self": "/v1/acl/objects/1z6rd",
"grants": "/v1/acl/grants?aclObjectId=1z6rd"
}
}
],
"openApiGitIntegrations": []
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
Response
200
application/json
200 response
The response is of type object
.
curl --request GET \
--url https://wmc.wiremockapi.cloud/v1/users/{userId}/apis \
--header 'Authorization: Basic <encoded-value>'
{
"links": {
"self": "/v1/users/9gd5l/apis?limit=20&page=1"
},
"meta": {
"start": 1,
"end": 1,
"total": 1,
"page": 1,
"totalPages": 1
},
"mockApis": [
{
"id": "63om1",
"aclObject": "1z6rd",
"name": "Example Mock API",
"description": "An API consisting of assorted stubs.",
"state": "RUNNING",
"adminSecurityEnabled": true,
"exportState": "EXPORT_ALLOWED",
"createdDate": "2024-08-23T20:15:32.432385Z",
"openApiGitIntegration": "63om1-openapi-integration-git",
"links": {
"self": "/v1/mock-apis/63om1",
"requests": "/v1/mock-apis/63om1/requests",
"mappings": "/v1/mock-apis/63om1/mappings",
"scenarios": "/v1/mock-apis/63om1/scenarios",
"recordings": {
"start": "/v1/mock-apis/63om1/recordings/start",
"stop": "/v1/mock-apis/63om1/recordings/stop",
"status": "/v1/mock-apis/63om1/recordings/status",
"snapshot": "/v1/mock-apis/63om1/recordings/snapshot"
},
"imports": "/v1/mock-apis/63om1/imports",
"organisation": "/v1/organisations/mgk7g",
"aclObject": "/v1/acl/objects/1z6rd",
"aclRoles": "/v1/acl/objects/1z6rd/roles",
"invitations": "/v1/mock-apis/63om1/invitations",
"acl": "/v1/mock-apis/63om1/acl{?subjectId}"
},
"baseUrl": "https://63om1.wiremockapi.cloud",
"domainNames": [
{
"domainName": "63om1.wiremockapi.cloud",
"urls": [
{
"url": "https://63om1.wiremockapi.cloud"
},
{
"url": "http://63om1.wiremockapi.cloud"
}
]
}
],
"domains": [
"63om1.wiremockapi.cloud"
]
}
],
"aclObjects": [
{
"id": "1z6rd",
"objectType": "mock-api",
"name": "Example Mock API",
"aclGrants": [
"9gd5l-1z6rd-mock_api_admin"
],
"links": {
"self": "/v1/acl/objects/1z6rd",
"grants": "/v1/acl/grants?aclObjectId=1z6rd"
}
}
],
"openApiGitIntegrations": []
}
Assistant
Responses are generated using AI and may contain mistakes.