---
title: "Get mock API by ID"
method: GET
path: "/v1/mock-apis/{mockApiId}"
tags: ["Mock APIs"]
---

# Get mock API by ID

`GET /v1/mock-apis/{mockApiId}`

## Response `200`

200 response

- MockApi
  - `mockApi` MockApiData, required
    - `id` string, required
    - `name` string, required — The display name of the mock API.
    - `description` string — The description of the mock API.
    - `type` 'openapi' | 'grpc' | 'graphql', nullable — The type of the mock API. Defaults to the "unstructured" type if not specified.
    - `state` string, required — Whether the API is running or stopped.
    - `adminSecurityEnabled` boolean, required — Whether security is enabled on the mock API's `/__admin/*` endpoints.
    - `createdDate` string, required
    - `aclObject` string — The ACL object ID of the entity.
    - `mockHost` string, nullable — The ID of the mock host where this mock API is located.
    - `links` object, required
      - `self` string, required
      - `requests` string, required
      - `mappings` string, required
      - `scenarios` string, required
      - `securitySettings` string
      - `recordings` object, required
        - `start` string, required
        - `stop` string, required
        - `status` string, required
        - `snapshot` string, required
      - `imports` string, required
      - `exports` object
        - `wiremock` string, required
      - `organisation` string, required
      - `invitations` string, required
      - `acl` string, required — The link to the access control list for this mock API.
      - `versionHistoryCommits` string, required
    - `domainNames` object[], required
      - `domainName` string, required
      - `urls` object[], required
        - `url` string, required
    - `baseUrl` string, required
    - `domains` string[], required — The list of domain names that can be used to address this mock API.

## Other responses

- `403` — 403 Unauthorized response

---

[API](https://skmtc.net/wiremock/apis/wiremock-cloud.md) · [All operations](https://skmtc.net/wiremock/apis/wiremock-cloud/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wiremock/wiremock-cloud/revisions/93bebefc672f/schema)