Postman CLI request commands (postman request)

The HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, or OPTIONS).

The target URL for the request.

Specifies the authentication type and parameters. Supports the basic, bearer, digest, oauth1, oauth2, hawk, aws, ntlm, and apikey authentication types.

For example: --auth-basic-username user --auth-basic-password pass or --auth-apikey-key "X-API-Key" --auth-apikey-value "abc123" --auth-apikey-in header

Specifies request body content. Supports inline string or @filepath syntax for files. For example: --body '{"name": "John"}' or --body @data.json

Specifies the file path for a JSON cookie jar to load cookies from before the request runs. This uses the tough-cookie library to deserialize the file.

Loads one or more local .dataset.yaml files, or directories of them, for the request to use. Pass --dataset more than once to load multiple datasets.

Shows detailed information in debug mode, including retry attempts, redirects, and timing breakdowns.

Specifies an environment file path or UUID. Resolves variables in the URL, headers, and body.

Specifies the path where the Postman CLI outputs the final cookie jar file after the request completes. This uses the tough-cookie library to serialize the file.

Specifies multipart/form-data in key=value format. Use @filepath syntax for files. Can be used multiple times.

For example: -f "name=John" or -f "avatar=@photo.jpg"

Specifies a header in key-value format. Can be used multiple times.

For example: -H Content-Type:application/json

Turns off SSL verification checks and enables self-signed SSL certificates.

Saves the complete response to a JSON file, including status, headers, body, and more. Use for debugging or further processing.

Usage analytics are reported to Postman by default, whether or not you pass --report-events. To turn reporting off, pass --report-events=false. You can also use --no-report-events.

Suppresses all output except the response body. This is useful for piping to other commands.

Preserves the original HTTP method when 3xx redirect responses. Redirects are followed with the GET method by default.

Prevents the Postman CLI from automatically following 3xx redirect responses. Redirects are followed by default.

Specifies the maximum number of 3xx redirect responses to follow. There is no limit by default. Useful for preventing redirect loops.

Removes the Referer header when following 3xx redirect responses. The Referer header is sent with redirects by default.

Specifies the number of retry attempts for failed requests, like a 400 Bad Request code. Useful for unreliable endpoints or rate limited APIs.

Specifies the time (in milliseconds) to wait to retry the request.

Adds JavaScript that runs after the request runs. Supports inline JavaScript or @filepath syntax for files. Learn more about writing post-response scripts.

For example: --script-post-request "console.log(pm.response.json());"

Adds JavaScript that runs before the request runs. Supports inline JavaScript or @filepath syntax for files. Learn more about writing pre-request scripts.

For example: --script-pre-request "pm.environment.set('timestamp', Date.now());"

Specifies the path to a client certificate (PEM).

Specifies the path to a client certificates configuration (JSON).

Specifies the path to a client certificate private key.

Specifies the client certificate passphrase (for a protected key).

Specifies more trusted CA certificates (PEM).

Specifies the time (in milliseconds) to wait for the request to complete.

Shows detailed information for the request and response, including headers, body, and metadata.