Postman

Postman Mocks API

Operations for creating and managing mock servers.

GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /mocks List mock servers · Get all mock servers #
Ask an LLM
“Which mock servers are currently active?”
“Can I list only the mock servers in one workspace or team?”
Tell an agent
List my active mock servers.
List the mock servers in workspace {workspace}.
POST /mocks Create a mock server for a collection · Create a mock server #
Ask an LLM
“How do I spin up a mock server from a collection?”
“Can I create a mock for a collection that's attached to an API definition?”
Tell an agent
Create a mock server in workspace {workspace}.
Create mock server {mock} in workspace {workspace}.
GET /mocks/{mockId} Get a mock server · Get a mock server #
Ask an LLM
“What's the URL and configuration of a particular mock server?”
“Can I look up which collection a mock server is based on?”
Tell an agent
Get mock server {mockId}.
Show the settings of mock {mockId}.
PUT /mocks/{mockId} Update a mock server · Update a mock server #
Ask an LLM
“Can I rename a mock server or point it at a different collection?”
“How do I change a mock server's settings?”
Tell an agent
Update mock server {mockId} with {mock}.
Rename mock server {mockId}.
DELETE /mocks/{mockId} Delete a mock server · Delete a mock server #
Ask an LLM
“How do I get rid of a mock server I don't use anymore?”
“Can I delete a mock server through the API?”
Tell an agent destructive · confirm first
Delete mock server {mockId}.
Remove the mock {mockId} permanently.
GET /mocks/{mockId}/call-logs Read a mock server's call logs · Get a mock server's call logs #
Ask an LLM
“What requests has my mock server received and what did it return?”
“Can I filter mock call logs by status code, method or path?”
Tell an agent
Show the call logs for mock server {mockId}.
Show mock {mockId} calls that returned status {responseStatusCode}.
POST /mocks/{mockId}/publish Make a mock server public · Publish a mock server #
Ask an LLM
“How do I make a mock server publicly accessible?”
“What does publishing a mock server change in its access control?”
Tell an agent
Publish mock server {mockId}.
Set the access control of mock {mockId} to public.
DELETE /mocks/{mockId}/unpublish Make a mock server private · Unpublish a mock server #
Ask an LLM
“Can I make a public mock server private again?”
“How do I stop a mock server from being publicly reachable?”
Tell an agent destructive · confirm first
Unpublish mock server {mockId}.
Switch mock {mockId} access control back to private.
GET /mocks/{mockId}/server-responses List a mock server's simulated server errors · Get all server responses #
Ask an LLM
“What simulated 5xx server responses are set up on this mock?”
“Can I list every server response configured for a mock server?”
Tell an agent
List the server responses on mock {mockId}.
Show all simulated server errors configured for mock {mockId}.
POST /mocks/{mockId}/server-responses Simulate a 5xx error on a mock server · Create a server response #
Ask an LLM
“Can a mock server simulate a 500 or 503 outage?”
“How do I test how my app handles server-level errors with a mock?”
Tell an agent
Add a server response {serverResponse} to mock {mockId}.
Make mock {mockId} simulate a 503 server error.
GET /mocks/{mockId}/server-responses/{serverResponseId} Get one simulated server response · Get a server response #
Ask an LLM
“How do I see the details of one simulated server response on a mock?”
“Which status code does a given mock server response return?”
Tell an agent
Get server response {serverResponseId} on mock {mockId}.
Show the status code of server response {serverResponseId} in mock {mockId}.
PUT /mocks/{mockId}/server-responses/{serverResponseId} Change a simulated server response · Update a server response #
Ask an LLM
“Can I change the status code of an existing simulated server error?”
“How do I edit a server response already set on a mock?”
Tell an agent
Update server response {serverResponseId} on mock {mockId} with {serverResponse}.
Change mock {mockId}'s server response {serverResponseId} to return a 500.
DELETE /mocks/{mockId}/server-responses/{serverResponseId} Remove a simulated server response · Delete a server response #
Ask an LLM
“How do I stop a mock from returning a simulated server error?”
“Can I delete one server response from a mock server?”
Tell an agent destructive · confirm first
Delete server response {serverResponseId} from mock {mockId}.
Remove the simulated error {serverResponseId} on mock {mockId}.

Documentation

📖
Documentation
https://www.postman.com/postman/postman-public-workspace/documentation/i2uqzpp/postman-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-mocks-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-mock-server-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-delete-mock-server-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-mock-call-logs-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-publish-unpublish-mock-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-mock-create-update-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-mocks-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postman:postman-mocks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postman-mocks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Mocks API
  version: 1.0.0
  description: 'Operations tagged mocks across 2 of this provider''s published API definitions: postman-api-openapi.yml, postman-mock-servers-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
- url: https://api.getpostman.com
  description: Postman Production API Server
tags:


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-mocks-api-openapi.yml