Postman
Arcade.dev tools for interacting with Postman
0.1.0The Postman toolkit lets Arcade interact with the Postman API to manage collections, environments, mock servers, monitors, workspaces, and API definitions programmatically.
Capabilities
- Collections & requests — create, read, update, fork, export (OpenAPI), and delete collections; manage folders and individual requests within them.
- Environments — create, inspect, update (including granular variable upserts/removals), and delete environments.
- Mock servers — create, inspect, list, and delete mock servers backed by a collection.
- Monitors — create, inspect, list, trigger synchronously, and delete monitors that run collections on a schedule; monitor timeouts are handled gracefully with a
timed_outflag. - Workspaces & APIs — list and inspect workspaces (with all contained resources), list and inspect API definitions, and read API schema files.
- Account introspection — identify the authenticated Postman account and its plan usage via
WhoAmI.
Secrets
POSTMAN_API_KEY — A Postman API key that authenticates every request. Generate one in the Postman web app under Settings → API keys (your avatar → Settings → API keys). The key inherits the permissions of your Postman account, so it can access any workspace, collection, or environment your account can reach. No special scopes are selectable; access is determined by your Postman plan and team role. Copy the key immediately after creation — Postman does not display it again. See Postman's API key documentation for details.
Store the key as an Arcade secret: https://docs.arcade.dev/en/guides/create-tools/tool-basics/create-tool-secrets. You can also manage secrets directly at https://api.arcade.dev/dashboard/auth/secrets.
Available tools(30)
| 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 |