Postman

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, read, update, delete, fork, and export collections as OpenAPI; add, rename, or remove folders and requests within a collection.
Environment management — create, inspect, update (including surgical per-variable edits), and delete environments.
Mock servers — create mock servers from collections, inspect their public URLs, and delete them.
Monitors — create scheduled collection monitors, inspect run schedules and results, trigger on-demand runs, and delete monitors.
Workspaces & APIs — list workspaces, inspect workspace contents, list and inspect API definitions and their schemas.
Account introspection — identify the authenticated Postman account and check plan usage.

Secrets

POSTMAN_API_KEY — A Postman API key that authenticates every request made by the toolkit. To obtain one:

Sign in to Postman and open your API keys settings page.
Click Generate API Key, give it a name, and copy the generated value immediately (it is not shown again).
The key inherits the permissions of your Postman account, so it can access all workspaces, collections, environments, mocks, and monitors that your account can see. A free-tier account is sufficient for most operations; some features (e.g., mock servers, monitors) require a paid plan.

See Postman API key docs for full details.

Store the key in Arcade using the secrets guide or directly in the Arcade dashboard.

Tool name	Description	Secrets
Postman.CreateCollectionFolder	Add a folder to a collection, optionally nested inside an existing folder.	1
Postman.CreateCollectionRequest	Add a request to a collection, optionally inside a folder.	1
Postman.CreateMock	Create a mock server from a collection so a client can call its simulated endpoints.	1
Postman.CreateMonitor	Create a monitor that runs a collection on a schedule to watch an API's health.	1
Postman.DeleteCollection	Permanently delete a collection. This cannot be undone.	1
Postman.DeleteCollectionItem	Delete a folder or request from a collection. This cannot be undone. Deleting a folder also removes the requests it contains.	1
Postman.DeleteEnvironment	Permanently delete an environment. This cannot be undone.	1
Postman.DeleteMock	Permanently delete a mock server. This cannot be undone.	1
Postman.DeleteMonitor	Permanently delete a monitor. This cannot be undone.	1
Postman.ForkCollection	Fork a collection into a workspace as an independent, editable copy.	1
Postman.GetApi	Inspect an API definition, including its name, summary, and attached schemas.	1
Postman.GetApiSchema	Read an API schema's files and their definition content.	1
Postman.GetCollection	Inspect a collection and return its variables and a flat tree of its folders and requests.	1
Postman.GetCollectionOpenapi	Export a collection as an OpenAPI definition.	1
Postman.GetEnvironment	Inspect an environment and return its variables.	1
Postman.GetMock	Inspect a mock server, including its public URL and the collection it is based on.	1
Postman.GetMonitor	Inspect a monitor, including its run schedule and most recent run result.	1
Postman.GetWorkspace	Inspect a workspace and list the collections, environments, mocks, and monitors in it.	1
Postman.ListApis	List the API definitions in a workspace.	1
Postman.ListCollections	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
Postman.ListEnvironments	List environments, optionally scoped to a workspace and filtered by name.	1
Postman.ListMocks	List mock servers, optionally scoped to a workspace and filtered by name.	1
Postman.ListMonitors	List monitors, optionally scoped to a workspace.	1
Postman.ListWorkspaces	List the workspaces the API key can access, optionally filtered by type.	1
Postman.RunMonitor	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

Capabilities

Secrets

Available tools(30)

Get Building