Get a mock server

GET

/mocks/:mockId

GET

/mocks/:mockId

$ curl https://api.getpostman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289 \
>      -H "x-api-key: <apiKey>"

1 {
2   "mock": {
3     "id": "e3d951bf-873f-49ac-a658-b2dcb91d3289",
4     "owner": "12345678",
5     "uid": "12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289",
6     "collection": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
7     "mockUrl": "https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io",
8     "name": "Test Mock",
9     "config": {
10       "headers": [],
11       "matchBody": false,
12       "matchQueryParams": true,
13       "matchWildcards": true,
14       "delay": {
15         "type": "fixed",
16         "duration": 140000
17       },
18       "serverResponseId": "94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65"
19     },
20     "createdAt": "2022-07-25T20:54:30.000Z",
21     "updatedAt": "2022-07-25T20:54:30.000Z",
22     "isPublic": false,
23     "deactivated": false,
24     "environment": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e"
25   }
26 }

Gets information about a mock server.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

mockIdstringRequired

The mock's ID.

Response

Successful Response

mockobject

Information about the mock server.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error