How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Postman Mocks API

Operations for creating and managing mock servers.

Postman Mocks API is one of 39 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mocks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 7 paths, and defines 106 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.

13 operations 7 paths 106 schemas 3 DELETE5 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.getpostman.com
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Postman Mocks API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (PostmanApiKey). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (scimApiKey).

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

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

mocks 13
GET
/mocks
Get all mock servers
getMocks 3 params → 200401500
POST
/mocks
Create a mock server
createMock 2 params body → 200400401500
GET
/mocks/{mockId}
Get a mock server
getMock 2 params → 200401404500
PUT
/mocks/{mockId}
Update a mock server
updateMock 2 params body → 200400401404500
DELETE
/mocks/{mockId}
Delete a mock server
deleteMock 2 params → 200401404500
GET
/mocks/{mockId}/call-logs
Get a mock server's call logs
getMockCallLogs 13 params → 200400401404500
POST
/mocks/{mockId}/publish
Publish a mock server
publishMock 2 params → 200400401404500
DELETE
/mocks/{mockId}/unpublish
Unpublish a mock server
unpublishMock 2 params → 200400401404500
GET
/mocks/{mockId}/server-responses
Get all server responses
getMockServerResponses 2 params → 200401404500
POST
/mocks/{mockId}/server-responses
Create a server response
createMockServerResponse 2 params body → 200400401404500
GET
/mocks/{mockId}/server-responses/{serverResponseId}
Get a server response
getMockServerResponse 3 params → 200401404500
PUT
/mocks/{mockId}/server-responses/{serverResponseId}
Update a server response
updateMockServerResponse 3 params body → 200400401404500
DELETE
/mocks/{mockId}/server-responses/{serverResponseId}
Delete a server response
deleteMockServerResponse 3 params → 200401404500

Schemas 106

The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are GetMockMock (12 properties), GetMocksMocksItems (12 properties), mockServerResponse (11 properties), MockCreateUpdateResponseMock (10 properties). Each schema is shown below with its type and property counts.

DeleteMockServerResponseRequestUnauthorizedError
GetMockCallLogsCallLogsItemsResponse
object
The server response's response information.
4 properties
UpdateMockMock
object
7 properties
commonErrorNameMessageDetails
object
1 property
GetMocksMocksItemsConfigDelay
object
Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings.
3 properties
CommonErrorTypeTitleDetailStatusType
mockRequestMethod
string
commonErrorTypeTitleDetail
object
3 properties
GetMockCallLogsCallLogsItemsResponseHeaders
object
The response's headers.
3 properties
MockCreateUpdateResponseMockConfig
object
Information about the mock server's configuration.
7 properties
publishUnpublishMockResponse
object
1 property
GetMockCallLogsCallLogsItems
object
Information about the mock server's server response.
5 properties
mockInclude
string
mockId
string
CreateMockRequestBadRequestError
GetMockCallLogsCallLogsItemsRequest
object
The server response's request information.
4 properties
DeleteMockRequestUnauthorizedError
GetMockCallLogsRequestUnauthorizedError
DeleteMockServerResponseRequestInternalServerError
MockCreateUpdateResponseMockConfigDelayType
string
The fixed value.
DeleteMockServerResponseLanguage
string
The server response's body language type.
deleteMock
object
1 property
getMockServerResponses
array
A list of the mock server's responses.
sinceDateTime
string
DeleteMockMock
object
Information about the mock server.
2 properties
mockResponseType
string
CreateMockServerResponseRequestUnauthorizedError
updateMock
object
1 property
GetMockServerResponsesRequestInternalServerError
CommonErrorNameMessageError
object
Information about the error.
2 properties
UpdateMockRequestUnauthorizedError
PublishMockRequestUnauthorizedError
GetMockCallLogsCallLogsItemsRequestBody
object
The request's body information.
2 properties
GetMockServerResponseRequestInternalServerError
GetMocksMocksItems
object
Information about the mock server.
12 properties
serverResponseId
string
getMockCallLogs
object
2 properties
getMock
object
1 property
updateMockServerResponse
object
1 property
CreateMockRequestUnauthorizedError
CreateMockServerResponseServerResponseHeadersItems
object
2 properties
GetMockMockConfigDelayType
string
The type of simulated delay value: - fixed — The delay value is a fixed value.
GetMockMockConfigDelay
object
Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings.
3 properties
PublishMockRequestBadRequestError
UpdateMockServerResponseServerResponseLanguage
string
The server response's body language type.
UpdateMockServerResponseServerResponseHeadersItems
object
Information about the key-value pair.
2 properties
commonErrorNameMessage
object
1 property
GetMockCallLogsMeta
object
The response's non-standard meta information.
1 property
GetMockCallLogsCallLogsItemsResponseHeadersDescription
object
The response header's description information.
2 properties
Mock500ErrorError
object
2 properties
MockServerResponse404ErrorError
object
3 properties
createMockServerResponse
object
1 property
UpdateMockRequestBadRequestError
GetMockCallLogsCallLogsItemsResponseBody
object
The response's body information.
1 property
getMocks
object
1 property
limitDefault100
number
GetMockServerResponsesItems
object
Information about the server response.
7 properties
ascDesc
string
UpdateMockServerResponseRequestBadRequestError
GetMockCallLogsRequestBadRequestError
mockRequestPath
string
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
workspaceId
string
GetMocksMocksItemsConfig
object
Information about the mock server's configuration.
6 properties
DeleteMockServerResponseHeadersItems
object
2 properties
cursor
string
CreateMockServerResponseRequestBadRequestError
mockServerResponse
object
Information about the mock server's response.
11 properties
MockCreateUpdateResponseMockConfigDelayPreset
string
The simulated fixed network delay value: - 1 — 2G (300 ms). - 2 — 3G (100 ms). The object does not return this value for custom delay values.
GetMocksRequestUnauthorizedError
mockCreateUpdateResponse
object
1 property
PublishUnpublishMockResponseMock
object
Information about the mock server.
1 property
UpdateMockServerResponseServerResponse
object
5 properties
GetMockMockConfig
object
Information about the mock server's configuration.
6 properties
mockSortServedAt
string
teamIdResultsQuery
string
deleteMockServerResponse
object
Information about the deleted server response.
9 properties
GetMockServerResponsesRequestUnauthorizedError
GetMockRequestUnauthorizedError
CreateMockServerResponseServerResponseLanguage
string
The server response's body language type.
GetMockMock
object
Information about the mock server.
12 properties
UpdateMockMockConfig
object
The mock server's configuration settings.
1 property
GetMocksMocksItemsConfigDelayPreset
string
The simulated fixed network delay value: - 1 — 2G (300 ms). - 2 — 3G (100 ms). The object does not return this value for custom delay values.
mock500Error
object
1 property
UnpublishMockRequestBadRequestError
UpdateMockServerResponseRequestInternalServerError
MockCreateUpdateResponseMock
object
Information about the mock server.
10 properties
UpdateMockServerResponseRequestUnauthorizedError
GetMockCallLogsRequestInternalServerError
MockCreateUpdateResponseMockConfigDelay
object
Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings.
3 properties
CreateMockServerResponseServerResponse
object
5 properties 2 required
GetMockServerResponseRequestUnauthorizedError
createMock
object
1 property
GetMockMockConfigDelayPreset
string
The simulated fixed network delay value: - 1 — 2G (300 ms). - 2 — 3G (100 ms). The object does not return this value for custom delay values.
GetMocksMocksItemsConfigDelayType
string
The type of simulated delay value: - fixed — The delay value is a fixed value.
commonErrorTypeTitleDetailStatus
object
4 properties
GetMockCallLogsCallLogsItemsRequestHeaders
object
The request's headers.
2 properties
UnpublishMockRequestUnauthorizedError
untilDateTime
string
CreateMockServerResponseRequestInternalServerError
mockResponseStatusCode
number
mockServerResponse404Error
object
1 property
CommonErrorTypeTitleDetailDetail
Information about the error.
CommonErrorNameMessageDetailsError
object
3 properties
CreateMockMock
object
4 properties 1 required
MockServerResponseHeadersItems
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-mocks-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

Postman Collections API
Postman Workspaces API
Postman Environments API
Postman Monitors API
Postman Webhooks API
Postman Tags API
Postman Billing API
Postman SCIM API
Postman MCP Server
Postman Flows
Postman analytics API
Where this information came from

This is an independent, third-party profile of Postman Mocks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.