Postman
Arcade toolkit · docs.arcade.dev
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.
Tools30
Postman_CreateCollectionFolder
Add a folder to a collection, optionally nested inside an existing folder.
Postman_CreateCollectionRequest
Add a request to a collection, optionally inside a folder.
Postman_CreateMock
Create a mock server from a collection so a client can call its simulated endpoints.
Postman_CreateMonitor
Create a monitor that runs a collection on a schedule to watch an API's health.
Postman_DeleteCollection
Permanently delete a collection. This cannot be undone.
Postman_DeleteCollectionItem
Delete a folder or request from a collection. This cannot be undone. Deleting a folder also removes the requests it contains.
Postman_DeleteEnvironment
Permanently delete an environment. This cannot be undone.
Postman_DeleteMock
Permanently delete a mock server. This cannot be undone.
Postman_DeleteMonitor
Permanently delete a monitor. This cannot be undone.
Postman_ForkCollection
Fork a collection into a workspace as an independent, editable copy.
Postman_GetApi
Inspect an API definition, including its name, summary, and attached schemas.
Postman_GetApiSchema
Read an API schema's files and their definition content.
Postman_GetCollection
Inspect a collection and return its variables and a flat tree of its folders and requests.
Postman_GetCollectionOpenapi
Export a collection as an OpenAPI definition.
Postman_GetEnvironment
Inspect an environment and return its variables.
Postman_GetMock
Inspect a mock server, including its public URL and the collection it is based on.
Postman_GetMonitor
Inspect a monitor, including its run schedule and most recent run result.
Postman_GetWorkspace
Inspect a workspace and list the collections, environments, mocks, and monitors in it.
Postman_ListApis
List the API definitions in a workspace.
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; the workspace's details list everything it holds.
Postman_ListEnvironments
List environments, optionally scoped to a workspace and filtered by name.
Postman_ListMocks
List mock servers, optionally scoped to a workspace and filtered by name.
Postman_ListMonitors
List monitors, optionally scoped to a workspace.
Postman_ListWorkspaces
List the workspaces the API key can access, optionally filtered by type.
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 the monitor's last-run fields rather than retrying.
Postman_SaveCollection
Create a new collection, or update an existing one when collection_id is provided.
Postman_SaveEnvironment
Create a new environment, or update an existing one when environment_id is provided.
Postman_UpdateCollectionItem
Rename a folder or request, or change a request's method or URL.
Postman_UpdateEnvironmentVariables
Set or remove individual environment variables without resending the whole variable set.
Postman_WhoAmI
Identify the Postman account the configured API key belongs to and its plan usage.