Postman
Arcade Optimized
Arcade.dev tools for interacting with Postman
Author:Arcade
Version:
0.1.0Auth:No authentication required
30tools
30require secrets
The Postman toolkit lets Arcade agents interact with the Postman API to manage collections, environments, mock servers, monitors, workspaces, and API definitions programmatically.
Capabilities
- Collection management — create, inspect, export (OpenAPI), fork, save, and permanently delete collections; add, update, and delete folders and requests within a collection.
- Environment management — create, inspect, update individual variables, and delete environments.
- Mock servers — create mock servers backed by a collection, inspect them (including their public URL), and delete them.
- Monitors — create scheduled collection monitors, inspect run history and schedules, trigger on-demand runs with pass/fail results, and delete monitors.
- Workspace and API discovery — list and inspect workspaces, list collections/environments/mocks/monitors scoped to a workspace, list and inspect API definitions and their schemas.
- Account introspection — identify the authenticated Postman account and its plan usage.
Secrets
POSTMAN_API_KEY — A Postman API key that authenticates every request made on behalf of a Postman account. To obtain one:
- Log in to Postman and open Settings → API keys (direct link: https://web.postman.co/settings/me/api-keys).
- Click Generate API Key, give it a descriptive name, and copy the value immediately — it is shown only once.
- The key inherits the permissions of the account that created it. For team workspaces, ensure the account has access to the workspaces and resources the toolkit needs to read or modify.
- Postman's API key documentation describes key scopes, rotation, and revocation.
Store the key as an Arcade secret. See the Arcade secrets guide for configuration instructions, and manage your secrets at https://api.arcade.dev/dashboard/auth/secrets.
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; use get_workspace to see everything a workspace 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 get_monitor's last-run fields rather than retrying. | 1 |
Page 1 of 2(25 of 30)
Last updated on