Postman Mocks API is one of 43 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Mock. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.
This API exposes
13 operations
across 7 paths,
and defines 109 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 3 base URLs: https://api.postman.com, https://api.eu.postman.com, https://api.getpostman.com.
The identity and technical contract details declared by the specification.
commonErrorTypeTitleDetail
object
3 properties
UpdateMockServerResponseServerResponse
object
5 properties
DeleteMockServerResponseRequestInternalServerError
getMocks
object
1 property
publishUnpublishMockResponse
object
1 property
UpdateMockServerResponseRequestInternalServerError
GetMockCallLogsCallLogsItemsResponseHeadersDescription
object
The response header's description information.
2 properties
DeleteMockServerResponseHeadersItems
object
2 properties
GetMockCallLogsCallLogsItemsResponse
object
The server response's response information.
4 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.
PublishUnpublishMockResponseMock
object
Information about the mock server.
1 property
UpdateMockServerResponseRequestUnauthorizedError
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
CreateMockMock
object
4 properties
1 required
mockServerResponse404Error
object
1 property
getMockServerResponses
array
A list of the mock server's responses.
GetMockCallLogsCallLogsItemsRequestHeaders
object
The request's headers.
2 properties
GetMockCallLogsCallLogsItemsRequestBody
object
The request's body information.
2 properties
GetMockCallLogsCallLogsItemsResponseHeaders
object
The response's headers.
3 properties
GetMockMockConfig
object
Information about the mock server's configuration.
6 properties
mockResponseStatusCode
number
CreateMockServerResponseRequestInternalServerError
CreateMockRequestUnauthorizedError
DeleteMockServerResponseRequestUnauthorizedError
GetMockCallLogsRequestInternalServerError
commonErrorNameMessageDetails
object
1 property
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
GetMockMock
object
Information about the mock server.
12 properties
UpdateMockServerResponseRequestBadRequestError
GetMockServerResponsesRequestInternalServerError
DeleteMockServerResponseLanguage
string
The server response's body language type.
CommonErrorTypeTitleDetailStatusType
UpdateMockServerResponseServerResponseHeadersItems
object
Information about the key-value pair.
2 properties
MockServerResponseHeadersItems
object
2 properties
CreateMockServerResponseServerResponseLanguage
string
The server response's body language type.
GetMockCallLogsRequestUnauthorizedError
GetMockCallLogsMeta
object
The response's non-standard meta information.
1 property
MockServerResponse404ErrorError
object
3 properties
GetMockServerResponseRequestUnauthorizedError
teamIdResultsQuery
string
GetMocksMocksItems
object
Information about the mock server.
12 properties
GetMockMockConfigDelayType
string
The type of simulated delay value: - fixed — The delay value is a fixed value.
UpdateMockRequestUnauthorizedError
MockCreateUpdateResponseMockConfig
object
Information about the mock server's configuration.
7 properties
GetMockCallLogsCallLogsItemsRequest
object
The server response's request information.
4 properties
UpdateMockMockConfig
object
The mock server's configuration settings.
1 property
PublishMockRequestUnauthorizedError
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.
GetMocksMocksItemsConfig
object
Information about the mock server's configuration.
6 properties
CommonErrorTypeTitleDetailDetail
Information about the error.
mock500Error
object
1 property
GetMocksMocksItemsConfigDelayType
string
The type of simulated delay value: - fixed — The delay value is a fixed value.
CreateMockRequestBadRequestError
deleteMockServerResponse
object
Information about the deleted server response.
9 properties
mockCreateUpdateResponse
object
1 property
GetMockCallLogsCallLogsItemsResponseBody
object
The response's body information.
1 property
MockCreateUpdateResponseMock
object
Information about the mock server.
10 properties
GetMockRequestUnauthorizedError
GetMockCallLogsRequestBadRequestError
Mock500ErrorError
object
2 properties
GetMocksRequestUnauthorizedError
DeleteMockMock
object
Information about the mock server.
2 properties
updateMock
object
1 property
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
createMockServerResponse
object
1 property
UnpublishMockRequestUnauthorizedError
createMock
object
1 property
CommonErrorNameMessageDetailsError
object
3 properties
CommonErrorNameMessageError
object
Information about the error.
2 properties
CreateMockServerResponseServerResponseHeadersItems
object
2 properties
GetMockCallLogsCallLogsItems
object
Information about the mock server's server response.
5 properties
UpdateMockRequestBadRequestError
deleteMock
object
1 property
getMockCallLogs
object
2 properties
CreateMockServerResponseRequestBadRequestError
commonErrorNameMessage
object
1 property
DeleteMockRequestUnauthorizedError
GetMockServerResponsesItems
object
Information about the server response.
7 properties
CreateMockServerResponseRequestUnauthorizedError
mockServerResponse
object
Information about the mock server's response.
11 properties
getMock
object
1 property
GetMockServerResponsesRequestUnauthorizedError
UpdateMockMock
object
7 properties
commonErrorTypeTitleDetailStatus
object
4 properties
GetMockServerResponseRequestInternalServerError
PublishMockRequestBadRequestError
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.
CreateMockServerResponseServerResponse
object
5 properties
2 required
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
updateMockServerResponse
object
1 property
MockCreateUpdateResponseMockConfigDelayType
string
The fixed value.
UpdateMockServerResponseServerResponseLanguage
string
The server response's body language type.
UnpublishMockRequestBadRequestError
MockServer
object
A Postman mock server that simulates API responses.
11 properties
MockServerInput
object
Input format for creating or updating a mock server.
6 properties
1 required
MockCallLog
object
A log entry for a request made to a mock server.
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Postman publishes across the network.