Postman
Product
PricingEnterprise
Resources and Support
API Network
Contact SalesSign InSign Up for Free
Postman Docs
  • Introduction
    • Overview
    • Resources
    • Feedback
    • Troubleshooting
  • Get started
    • Welcome
    • Postman first steps
      • Overview
      • Download
      • Send a request
      • Write a test
      • Sign in
      • Create a collection
      • Explore the Postman API Network
      • Next steps
    • Postman basics
      • Overview
      • The Postman interface
      • Postman elements
      • The Postman Agent
      • Postbot
      • Postman VS Code extension
      • Collaboration basics
      • Syncing
      • Lightweight API Client
      • Scratch Pad
    • Your Postman account
      • Overview
      • Sign up
      • Settings
    • Install and configure
      • Overview
      • Installation and updates
      • Settings
      • Customize your profile
      • Proxy server configuration
    • Import and export data
      • Overview
      • Data import methods
      • SoapUI import
      • Hoppscotch import
      • Insomnia import
      • Thunder Client import
      • Git import
      • New Relic import
      • cURL command import
      • Swagger API import
      • Data export
  • Send requests
    • Overview
    • Create requests
      • Overview
      • Request basics
      • Parameters and body data
      • Request headers
      • Test data storage
      • Customize request settings
      • Group requests in collections
      • Generate client code
    • Authentication and authorization
      • 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)
    • Response data and cookies
      • Overview
      • API response structure
      • Visualize request responses
      • Create request response examples
      • Create and send cookies
      • Debug requests
    • Variables and environments
      • Overview
      • Store values in variables
      • Create and use environments
      • Set environment variables
      • Manage team environments
      • Pinned environments
    • Postman Vault
      • Overview
      • Manage vault key
      • Vault secrets
      • Vault secrets for public APIs
      • Postman Vault integrations
        • Integrations overview
        • 1Password
        • AWS Secrets Manager
        • Azure Key Vault
        • HashiCorp Vault
        • Manage integrations
      • Troubleshoot vault secrets
    • Capture API traffic
      • Overview
      • Capture traffic with Postman proxy
      • Capture HTTP requests
      • Capture HTTPS traffic
      • Capture traffic with Postman Interceptor
      • Sync cookies
    • GraphQL
      • Overview
      • Create GraphQL requests
      • The GraphQL interface
      • Other GraphQL requests
    • gRPC
      • Overview
      • The gRPC interface
      • Invoke a gRPC request
      • Manage gRPC service definitions
      • Test gRPC requests
      • Write tests for gRPC requests
      • Postman Sandbox API
      • gRPC mock servers
      • gRPC request-response examples
      • gRPC protobuf types
    • WebSocket
      • 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
    • MQTT
      • Overview
      • Manage MQTT requests
      • Create an MQTT request
    • SOAP
      • Send SOAP requests
  • Tests and scripts
    • Overview
    • Write scripts
      • Overview
      • Write pre-request scripts
      • Write tests
      • Use packages in scripts
        • Overview
        • Reuse internal scripts
        • Use packages from external registries
      • Script examples
      • Dynamic variables
      • Postman JavaScript reference
    • Test APIs
      • Overview
      • Integration testing
      • End-to-end testing
      • Regression testing
      • Performance testing
    • Run and automate tests
      • Overview
      • Run tests manually
      • Run tests on a schedule
      • Run tests in CI/CD pipelines
      • Run tests with monitors
  • Postman Collections
    • Overview
    • Create and manage collections
      • Overview
      • Create collections
      • Add requests to collections
      • Manage and organize collections
      • Collaborate with collections
      • View collection activity and elements
    • Run collections
      • Overview
      • Collection Runner
      • Automate collection runs
      • View scheduled collection runs
      • Schedule collection runs with monitors
      • Trigger collection runs
      • Customize collection run order
      • Run a collection with imported data
    • Test API performance
      • Overview
      • Run a performance test
      • View performance test metrics
      • Debug performance test errors
      • Inject data into virtual users
    • Postman CLI
      • Overview
      • Install
      • Command options
      • Run a collection
      • Built-in reporters
    • Newman CLI
      • 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
    • Monitor collections
      • Overview
      • Set up a monitor
      • View monitor results
      • Manage monitors
      • Run monitors using static IPs
      • Troubleshoot monitors
      • Monitoring FAQ
  • Collaborate in Postman
    • Overview
    • Collaboration concepts
    • Collaboration features
    • Define roles
    • Use teams
    • Manage user groups
    • Manage access
    • Share your work
    • Comment on APIs
    • Document APIs
      • Overview
      • Document a collection
      • Add API documentation
      • Write documentation
      • Publish documentation
      • View documentation
      • Host API documentation
      • Set up authentication for public APIs
      • Run in Postman
        • Overview
        • Create Run in Postman buttons
        • Code with Run in Postman
    • Private API Network
      • Overview
      • Explore your Private API Network
      • Organize your Private API Network
      • Manage your Private API Network
      • Request additions to your Private API Network
      • Automate publishing to your Private API Network
    • Version control
      • Overview
      • Fork Postman elements
      • Create pull requests
      • Review pull requests
      • Watch pull requests
    • Public elements
    • Workspaces
      • Overview
      • Create workspaces