For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Postman
PricingEnterprise
Contact SalesSign InSign Up for Free
HomeDocs
HomeDocs
      • Overview
        • Run and test collections with Newman CLI
        • Install and run Newman
        • Newman command reference
        • Upload files with Newman
        • Use Newman built-in reporters
        • Use Newman external and custom reporters
        • Newman with Docker
        • CI with Newman
        • Travis CI with Newman
        • Jenkins with Newman
        • Migrate to the Postman CLI
  • Welcome
  • Postman quick start
  • Overview
  • The Postman interface
  • Postman elements
  • The Postman Agent
  • Postman AI features
  • Agent Mode
  • Passport
  • Fabric AI Gateway
  • Syncing
  • Lightweight API Client
  • Scratch Pad
  • Overview
  • System requirements
  • Install the Postman app
  • Update Postman
  • Firewall configuration
  • Troubleshooting
  • Overview
  • General settings
  • Working directory
  • Themes
  • Shortcuts
  • AI
  • Data
  • Add-ons
  • Certificates
  • Connected accounts
  • Proxy
  • Overview
  • Sign up and sign in
  • Manage your account
  • Manage account settings
  • Customize your profile
  • Proxy server configuration
  • Overview
  • FAQ
  • Overview
  • Data import methods
  • Migrate from other API clients
  • Data export
  • Troubleshooting
  • Overview
  • Overview
  • Overview
  • Request basics
  • Parameters and body data
  • Request headers
  • Test data storage
  • Customize request settings
  • Group requests in collections
  • Generate client code
  • Overview
  • Add certificates
  • Request authorization
  • Public API authorization
  • Authorization types
  • Digest
  • OAuth 1.0
  • OAuth 2.0
  • Hawk
  • AWS Signature
  • NTLM
  • Akamai Edgegrid
  • ASAP (Atlassian)
  • Overview
  • API response structure
  • Visualize request responses
  • Create request response examples
  • Create and send cookies
  • Debug requests
  • Overview
  • Store values in variables
  • Define variables
  • Use variables
  • Share variables
  • View and edit variables
  • Create and use environments
  • Set environment variables
  • Manage team environments
  • Environment colors
  • Pinned environments
  • Overview
  • Overview
  • Create AI requests
  • Add MCP servers
  • Interact with AI models
  • Manage AI request settings
  • Overview
  • Create a data request
  • Overview
  • Create GraphQL requests
  • The GraphQL interface
  • Other GraphQL requests
  • Overview
  • The gRPC interface
  • Invoke a gRPC request
  • Manage gRPC service definitions
  • Test gRPC requests
  • gRPC mock servers
  • gRPC request-response examples
  • gRPC protobuf types
  • Overview
  • Create MCP requests
  • Interact with MCP servers
  • Manage MCP request settings
  • Debug OAuth 2.1 authentication
  • Add servers to MCP hosts
  • Overview
  • Manage MQTT requests
  • Create an MQTT request
  • Send SOAP requests
  • Send requests to Unix sockets or named pipes
  • Webhooks
  • Overview
  • Create a WebSocket request
  • Create a Socket.IO request
  • Work with WebSocket messages
  • Listen to Socket.IO events
  • Use variables in WebSocket requests
  • Add details to a WebSocket request
  • Save WebSocket requests
  • Document WebSocket requests
  • Troubleshoot WebSocket requests
  • Overview
  • Create collections
  • Add requests to collections
  • Manage and organize collections
  • Collaborate with collections
  • View collection activity and elements
  • About collection schemas
  • Overview
  • Set up Native Git
  • Develop locally
  • Collaborate with your team
  • Automate with CI/CD
  • Develop with a coding agent
  • Overview
  • Get started
  • Run tasks with AI Skills
  • Agent Mode Enterprise
  • Use Postman AI Recipes
  • Troubleshoot Agent Mode
  • Overview
  • Get started
  • Automations
  • Get started
  • Query with an MCP client
  • Overview
  • Access Postman Vault
  • Create vault secrets
  • Use vault secrets
  • Export and import vault secrets
  • Integrations overview
  • 1Password
  • AWS Secrets Manager
  • Azure Key Vault
  • HashiCorp Vault
  • Manage integrations
  • Troubleshoot vault secrets
  • Overview
  • Capture traffic with Postman proxy
  • Capture HTTP requests
  • Capture HTTPS traffic
  • Capture traffic with Postman Interceptor
  • Overview
  • Inspect network traffic
  • Automate web applications
  • Sync cookies
  • Overview
  • Overview
  • Write pre-request scripts
  • Write tests
  • Overview
  • Reuse internal scripts
  • Use packages from external registries
  • Script examples
  • Dynamic variables
  • Overview
  • pm variables methods
  • pm.vault
  • pm.cookies
  • pm.request
  • pm.response
  • pm.sendrequest
  • pm.visualizer
  • pm.test and pm.expect
  • pm.require
  • pm.execution
  • pm.message
  • pm.info
  • pm.mock
  • pm.datasets
  • pm.state
  • Troubleshoot test errors
  • Overview
  • Create datasets
  • Manage datasets
  • Use datasets
  • Query datasets with SQL
  • Query datasets in scripts
  • Overview
  • Integration testing
  • End-to-end testing
  • Regression testing
  • Performance testing
  • Overview
  • Run tests manually
  • Run tests on a schedule
  • Run tests in CI/CD pipelines
  • Run tests with monitors
  • Overview
  • Integrate your test suite
  • Application testing FAQs
  • Overview
  • Collection Runner
  • Automate collection runs
  • View scheduled collection runs
  • Run with a mock
  • Schedule collection runs with monitors
  • Trigger collection runs
  • Customize collection run order
  • Overview
  • Data files
  • Datasets
  • Overview
  • Run a collection
  • Run a monitor
  • Run a performance test
  • Built-in reporters
  • Overview
  • Run a performance test
  • View performance test metrics
  • Overview
  • Test assertion failure trends
  • Test assertions by virtual user load
  • Debug performance test errors
  • View performance test run timeline
  • Overview
  • Data files
  • Datasets
  • Troubleshoot performance tests
  • Overview
  • Set up a monitor
  • Overview
  • Data files
  • Datasets
  • View monitor results
  • Overview
  • Publish monitor reports
  • Update monitor reports
  • Manage monitors
  • Overview
  • Configure a runner
  • Set up a runner in your network
  • Overview
  • Configure a runner to use a proxy server
  • Start a runner with the built-in proxy server
  • Manage a runner
  • Scale runners in your network
  • Troubleshoot
  • Run monitors using static IPs
  • Troubleshoot monitors
  • Monitoring FAQ
  • Overview
  • Build API mocks with JavaScript
  • Deploy a mock server
  • Make calls to mock servers
  • Create dynamic mock responses
  • Matching algorithm
  • Overview
  • Mock with response examples
  • Mock with the Postman API
  • Run simulations
  • Overview
  • Collaboration concepts
  • Collaboration features
  • Work within teams
  • Manage access
  • Share your work
  • Collaborate with Live Sessions
  • Comment on APIs
  • Overview
  • Overview
  • Document a collection
  • Add API documentation
  • Write documentation
  • Publish documentation
  • View documentation
  • Host API documentation
  • Set up authentication for public APIs
  • Overview
  • Explore your Private API Network
  • Manage your Private API Network
  • Migrate your Private API Network
  • Overview
  • Fork Postman elements
  • Create pull requests
  • Review pull requests
  • Watch pull requests
  • Public elements
  • Overview
  • Create workspaces
  • Overview
  • Use workspaces
  • Manage workspaces
  • Share workspace updates
  • Overview
  • Set up a Partner Workspace
  • Collaborate as a partner
  • Multi-partner Workspaces
  • Manage Partner Workspaces
  • Team-to-team FAQ
  • Public workspaces
  • Workspace documents
  • Overview
  • Overview
  • Add types to parameters and headers
  • Add types to body data
  • View types and documentation
  • Generate API specifications
  • Overview
  • Create a specification
  • Import a specification
  • Edit a specification
  • Edit with the Visual editor
  • Add files to a specification
  • Validate a specification
  • View live documentation
  • Reuse components
  • Collaborate with specifications
  • Generate collections
  • Sync collections and specifications reference
  • Migrate from API Builder to Spec Hub
  • Develop APIs with the API Builder
  • About MCP toolsets in Postman
  • Generate and implement MCP tools in Postman
  • Overview
  • Overview
  • Overview
  • Cloud connectors
  • Code discovery
  • Postman Insights
  • Cluster Watcher
  • Set up CLI reporting
  • Explore your services
  • Create and manage scorecards
  • Monitor security findings
  • Overview
  • Manage governance groups
  • Manage rulesets and functions
  • Monitor API governance with reports
  • Overview
  • Overview
  • Try a local demo
  • Overview
  • Daemonset
  • Sidecar
  • AWS ECS
  • AWS EC2
  • AWS Elastic Beanstalk
  • Debug with Insights
  • Customize Insights
  • Overview
  • Memory errors
  • Traffic errors
  • Uninstall Insights Agent
  • Overview
  • Access
  • Redactions
  • Repro mode security
  • DaemonSet security
  • Overview
  • Overview
  • Overview tab
  • Errors tab
  • Latency tab
  • Endpoints tab
  • Diagnostics tab
  • Settings tab
  • Overview
  • API Catalog deployment modes
  • apidump
  • kube inject
  • kube helm-fragment
  • kube tf-fragment
  • ecs add
  • ecs task-def
  • ecs cf-fragment
  • completion
  • FAQ
  • Overview
  • Workspace reports