Create a server response

POST

/mocks/:mockId/server-responses

POST

/mocks/:mockId/server-responses

$ curl -X POST https://api.getpostman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289/server-responses \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "serverResponse": {
>     "name": "Internal Server Error",
>     "statusCode": 500,
>     "headers": [
>       {
>         "key": "Content-Type",
>         "value": "application/json"
>       }
>     ],
>     "language": "json",
>     "body": "{\n    \"message\": \"Something went wrong; try again later.\"\n}"
>   }
> }'

1 {
2   "createdAt": "2022-08-02T15:08:03.000Z",
3   "updatedAt": "2022-08-02T15:08:03.000Z",
4   "id": "965cdd16-fe22-4d96-a161-3d05490ac421",
5   "name": "Internal Server Error",
6   "statusCode": 500,
7   "headers": [
8     {
9       "key": "Content-Type",
10       "value": "application/json"
11     }
12   ],
13   "language": "json",
14   "body": "{\n    \"message\": \"Something went wrong; try again later.\"\n}",
15   "createdBy": "12345678",
16   "updatedBy": "12345678",
17   "mock": "32cd624d-9986-4f20-9048-89252f722269"
18 }

Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503.

Server-level responses are agnostic to application-level logic. Server responses let you simulate this behavior on a mock server. You do not need to define each error for all exposed paths on the mock server.

If you set a server response as active, then all the calls to the mock server return with that active server response.

Note:

You can create multiple server responses for a mock server, but only one mock server can be set as active.

Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503. Server-level responses are agnostic to application-level logic. Server responses let you simulate this behavior on a mock server. You do not need to define each error for all exposed paths on the mock server. If you set a server response as active, then all the calls to the mock server return with that active server response. **Note:** You can create multiple server responses for a mock server, but only one mock server can be set as active.

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.

Request

This endpoint expects an object.

serverResponseobjectOptional

Response

Successful Response

createdAtdatetime

The date and time at which the server response was created.

updatedAtdatetime

The date and time at which the server response was last updated.

idstring

The server response's ID.

namestring

The server response's name.

statusCodedouble

The server response's 5xx HTTP response code.

headerslist of objects

The server response’s request headers key-value pairs, such as Content-Type, Accept, encoding, and other information.

languagestring

The server response's body language type.

bodystring

The server response's body that returns when calling the mock server.

createdBystring

The user ID of the user who created the server response.

updatedBystring

The user ID of the user who last updated the server response.

mockstring

The associated mock server's ID.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error