Create a mock server

POST

/mocks

POST

/mocks

$ curl -X POST "https://api.postman.com/mocks?workspace=1f0df51a-8658-4ee8-a2a1-d2567dfa09a9" \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "mock": {
>     "collection": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
>     "environment": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e",
>     "name": "Test Mock",
>     "private": true
>   }
> }'

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       "matchBody": false,
11       "headers": [
12         "POST"
13       ],
14       "matchQueryParams": true,
15       "matchWildcards": true,
16       "delay": {
17         "type": "fixed",
18         "duration": 300,
19         "preset": "1"
20       },
21       "serverResponseId": "9a291bbe-dc0a-44ba-a3c8-6dbd06a61460"
22     },
23     "createdAt": "2022-06-09T19:00:39.000Z",
24     "updatedAt": "2022-06-09T19:00:39.000Z",
25     "environment": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e"
26   }
27 }

Creates a mock server in a collection.

Note:

You cannot create mocks for collections added to an API definition.
If you do not include the workspaceId query parameter, the system creates the mock server in the oldest personal Internal workspace you own.

Creates a mock server in a collection. **Note:** - You cannot create mocks for collections added to an API definition. - If you do not include the `workspaceId` query parameter, the system creates the mock server in the oldest personal Internal workspace you own.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

workspacestringRequired

The workspace's ID.

Request

This endpoint expects an object.

mockobjectOptional

Response

Successful Response

mockobject

Information about the mock server.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error