GET
/
v1
/
mock-apis
/
{mockApiId}
curl --request GET \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "mockApi": {
    "id": "jjl8y",
    "aclObject": "gkqjy",
    "name": "My new mock API",
    "state": "RUNNING",
    "adminSecurityEnabled": true,
    "exportState": "EXPORT_ALLOWED",
    "createdDate": "2024-08-23T21:34:36.595372Z",
    "openApiGitIntegration": "jjl8y-openapi-integration-git",
    "links": {
      "self": "/v1/mock-apis/jjl8y",
      "requests": "/v1/mock-apis/jjl8y/requests",
      "mappings": "/v1/mock-apis/jjl8y/mappings",
      "scenarios": "/v1/mock-apis/jjl8y/scenarios",
      "recordings": {
        "start": "/v1/mock-apis/jjl8y/recordings/start",
        "stop": "/v1/mock-apis/jjl8y/recordings/stop",
        "status": "/v1/mock-apis/jjl8y/recordings/status",
        "snapshot": "/v1/mock-apis/jjl8y/recordings/snapshot"
      },
      "imports": "/v1/mock-apis/jjl8y/imports",
      "organisation": "/v1/organisations/mgk7g",
      "apiTemplate": "/v1/api-templates/8nd5x",
      "aclObject": "/v1/acl/objects/gkqjy",
      "aclRoles": "/v1/acl/objects/gkqjy/roles",
      "invitations": "/v1/mock-apis/jjl8y/invitations",
      "acl": "/v1/mock-apis/jjl8y/acl{?subjectId}"
    },
    "baseUrl": "https://jjl8y.wiremockapi.cloud",
    "domainNames": [
      {
        "domainName": "my-new-mock-api.wiremockapi.cloud",
        "editableSubdomainPart": "my-new-mock-api",
        "urls": [
          {
            "url": "https://my-new-mock-api.wiremockapi.cloud"
          },
          {
            "url": "http://my-new-mock-api.wiremockapi.cloud"
          }
        ]
      },
      {
        "domainName": "jjl8y.wiremockapi.cloud",
        "urls": [
          {
            "url": "https://jjl8y.wiremockapi.cloud"
          },
          {
            "url": "http://jjl8y.wiremockapi.cloud"
          }
        ]
      }
    ],
    "domains": [
      "jjl8y.wiremockapi.cloud",
      "my-new-mock-api.wiremockapi.cloud"
    ]
  },
  "openApiGitIntegrations": [
    {
      "test": "/v1/mock-apis/jjl8y/open-api-integrations/git/test",
      "mockApi": "jjl8y",
      "enabled": false,
      "id": "jjl8y-openapi-integration-git",
      "links": {
        "self": "/v1/mock-apis/jjl8y/open-api-integrations/git"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

mockApiId
string
required

The ID of the Mock API

Required string length: 5 - 10

Response

200
application/json
200 response
mockApi
object
required