Postman
Arcade Optimized
Arcade.dev tools for interacting with Postman
Author:Arcade
Version:
1.0.7Auth:No authentication required
30tools
30require secrets
Postman is an API development platform. This toolkit lets agents manage Postman workspaces, collections, environments, mock servers, monitors, and API definitions through the Postman API.
Capabilities
- Collections: list, inspect, create, update, fork, and delete collections; add, rename, and delete folders and requests; and export a collection as an OpenAPI definition.
- Environments: list, inspect, create, update, and delete environments, and set or remove individual variables.
- Mock servers: create a mock server from a collection, inspect it and its public URL, and delete it.
- Monitors: create monitors that run a collection on a schedule, inspect their schedule and last result, run one on demand, and delete them.
- Workspaces and APIs: list and inspect workspaces and their contents, and read API definitions and their schemas.
- Account: identify the account the API key belongs to and its plan usage.
The delete tools are permanent and cannot be undone.
Secrets
POSTMAN_API_KEY: a Postman API key, sent with every request. In Postman, open Settings > API keys (direct link), generate a key, and copy it right away, because Postman shows it only once. The key has the permissions of the account that created it, so that account needs access to the workspaces the toolkit reads or changes. See Postman's API authentication docs.
Store the secret in Arcade as described in the Arcade secrets docs, or manage it in the Arcade dashboard.
Available tools(30)
30 of 30 tools
Operations
Behavior
| Tool name | Description | Secrets | |
|---|---|---|---|
Add a folder to a collection, optionally nested inside an existing folder. | 1 | ||
Add a request to a collection, optionally inside a folder. | 1 | ||
Create a mock server from a collection so a client can call its simulated endpoints. | 1 | ||
Create a monitor that runs a collection on a schedule to watch an API's health. | 1 | ||
Permanently delete a collection. This cannot be undone. | 1 | ||
Delete a folder or request from a collection. This cannot be undone.
Deleting a folder also removes the requests it contains. | 1 | ||
Permanently delete an environment. This cannot be undone. | 1 | ||
Permanently delete a mock server. This cannot be undone. | 1 | ||
Permanently delete a monitor. This cannot be undone. | 1 | ||
Fork a collection into a workspace as an independent, editable copy. | 1 | ||
Inspect an API definition, including its name, summary, and attached schemas. | 1 | ||
Read an API schema's files and their definition content. | 1 | ||
Inspect a collection and return its variables and a flat tree of its folders and requests. | 1 | ||
Export a collection as an OpenAPI definition. | 1 | ||
Inspect an environment and return its variables. | 1 | ||
Inspect a mock server, including its public URL and the collection it is based on. | 1 | ||
Inspect a monitor, including its run schedule and most recent run result. | 1 | ||
Inspect a workspace and list the collections, environments, mocks, and monitors in it. | 1 | ||
List the API definitions in a workspace. | 1 | ||
List collections, optionally scoped to a workspace and filtered by name.
Without a workspace this returns the collections the API key can access: those you own or
have subscribed to. A collection another team member created in a shared workspace may not
appear here until it is subscribed to; the workspace's details list everything it holds. | 1 | ||
List environments, optionally scoped to a workspace and filtered by name. | 1 | ||
List mock servers, optionally scoped to a workspace and filtered by name. | 1 | ||
List monitors, optionally scoped to a workspace. | 1 | ||
List the workspaces the API key can access, optionally filtered by type. | 1 | ||
Trigger a monitor to run now and return its pass/fail results.
The run is synchronous: Postman holds the connection until the collection finishes. A run
that outlasts the tool's bounded wait returns ``timed_out=true`` while still executing
upstream; read the outcome from the monitor's last-run fields rather than retrying. | 1 |
Page 1 of 2(25 of 30)
Last updated on