curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/mock-apis \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"mockApi": {
"name": "<string>",
"description": "<string>",
"apiTemplateId": "<string>",
"type": "openapi",
"hostname": "<string>"
}
}
'{
"mockApi": {
"id": "<string>",
"name": "<string>",
"state": "<string>",
"adminSecurityEnabled": true,
"createdDate": "<string>",
"links": {
"self": "<string>",
"requests": "<string>",
"mappings": "<string>",
"scenarios": "<string>",
"recordings": {
"start": "<string>",
"stop": "<string>",
"status": "<string>",
"snapshot": "<string>"
},
"imports": "<string>",
"organisation": "<string>",
"invitations": "<string>",
"acl": "<string>",
"versionHistoryCommits": "<string>",
"securitySettings": "<string>",
"exports": {
"wiremock": "<string>"
}
},
"domainNames": [
{
"domainName": "<string>",
"urls": [
{
"url": "<string>"
}
]
}
],
"baseUrl": "<string>",
"domains": [
"<string>"
],
"description": "<string>",
"type": "openapi",
"aclObject": "<string>"
}
}curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/mock-apis \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"mockApi": {
"name": "<string>",
"description": "<string>",
"apiTemplateId": "<string>",
"type": "openapi",
"hostname": "<string>"
}
}
'{
"mockApi": {
"id": "<string>",
"name": "<string>",
"state": "<string>",
"adminSecurityEnabled": true,
"createdDate": "<string>",
"links": {
"self": "<string>",
"requests": "<string>",
"mappings": "<string>",
"scenarios": "<string>",
"recordings": {
"start": "<string>",
"stop": "<string>",
"status": "<string>",
"snapshot": "<string>"
},
"imports": "<string>",
"organisation": "<string>",
"invitations": "<string>",
"acl": "<string>",
"versionHistoryCommits": "<string>",
"securitySettings": "<string>",
"exports": {
"wiremock": "<string>"
}
},
"domainNames": [
{
"domainName": "<string>",
"urls": [
{
"url": "<string>"
}
]
}
],
"baseUrl": "<string>",
"domains": [
"<string>"
],
"description": "<string>",
"type": "openapi",
"aclObject": "<string>"
}
}Show child attributes
The display name of the mock API.
256The description of the mock API.
256The 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, graphql 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.
201 Created response
Show child attributes
The display name of the mock API.
256Whether the API is running or stopped.
Whether security is enabled on the mock API's /__admin/* endpoints.
Show child attributes
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 description of the mock API.
256The type of the mock API. Defaults to the "unstructured" type if not specified.
openapi, grpc, graphql The ACL object ID of the entity.