Flows commands
This topic covers flows management commands for the Postman CLI. You can use the postman flows commands to run, manage, and analyze flows.
postman flows list
The postman flows list command lists the flows available in a workspace. Specify the workspace by its ID.
To use this command, sign in to Postman with the postman login command.
Usage
Options
Specifies the workspace by its ID. This option is required for the postman flows list command.
Example
postman flows trigger
You can use the postman flows trigger command to trigger a deployed flow to run. The deployed flow must have a request trigger. This command requires the flow’s ID as an argument. You can also assign values to the flow’s inputs with the --input option.
To use this command, sign in to Postman with the postman login command.
Usage
The unique identifier of the flow to trigger.
Options
Set flow inputs with key=value pairs and/or paths to JSON files.
Example
postman flows deploy
You can use the postman flows deploy command to deploy a flow to the Postman cloud. This command requires the flow’s ID as an argument and the --path option. The --path option is the URL segment for the trigger, and must be unique for the team. For example, in the URL deployed-flow.flows.pstmn.io/api/default/new-flow, the path is /new-flow.
To use this command, sign in to Postman with the postman login command.
Usage
The unique identifier of the flow to deploy.
Specifies the path that will be added to the domain where the flow is deployed. This option is required for the postman flows deploy command.
Example
postman flows run
This command runs a single flow from your local repo. The flow runs requests and logic blocks entirely locally on your machine, making it ideal for CI/CD workflows. Successful runs return status and output. The postman flows run command has options to set input values, show run log information, and use values from a scenario. This command requires the local flow’s file path as an argument.
The postman flows run command is available with Postman Enterprise plans.
To use this command, sign in to Postman with the postman login command.
Usage
The local file path to the flow JSON file to run.
Options
Specify whether to override the default exit code for the current run.
Show detailed information about the flow run and each request (method, URL, assertions).
Set flow inputs with key=value pairs and/or paths to JSON files.
Set flow inputs from JSON files.
Reference a pre-built scenario as flow inputs by its name. Can be combined with --input to override values.
Examples
Learn more at Postman Flows overview.
postman flows update
You can use the postman flows update command to update auth and online/offline settings for a deployed flow. This command requires the flow’s ID as an argument.
To use this command, sign in to Postman with the postman login command.
Usage
The unique identifier of the deployed flow to update.
Options
Sets the deployed flow’s status to online (on) or offline (off).
Turns the flow’s authentication setting on or off.
Example
postman flows list-runs
You can use the postman flows list-runs command to fetch run history for a deployed flow in a specified workspace. The result displays the run’s timestamp, ID, duration, status, and flow name in a table. This command requires the --workspace option.
To use this command, sign in to Postman with the postman login command.
Usage
Options
Specifies the workspace by its ID. This option is required for the postman flows list-runs command.
Filter by flow ID.
Specifies the time window in minutes (1m), hours (1h), or days (1d).
Example
postman flows get-run
You can use the postman flows get-run command to analyze a specific run.
To use this command, sign in to Postman with the postman login command.
Usage
Options
Specifies the run by its ID. This option is required for the postman flows get-run command.
Shows the full event log including each block’s ID, input, and output.
Narrows output by block ID.