- Introduction
- Installing and updating
- Navigating Postman
- Sending your first request
- Managing your account
- Syncing your work
- Discovering templates
- Creating your first collection
- Creating a workspace
- Setting up your Postman app
- Importing and exporting data
- Troubleshooting app issues
- Building requests
- Authorizing requests
- Receiving responses
- Grouping requests in collections
- Using variables
- Managing environments
- Visualizing responses
- Specifying examples
- Using cookies
- Working with certificates
- Generating client code
- Troubleshooting requests
- Using the Collection Runner
- Scheduling runs with monitors
- Building request workflows
- Importing data files
- Working with your team
- Defining roles
- Requesting access
- Sharing your work
- Your private API network
- Commenting on collections
- Versioning APIs
- Using version control
- Using the API Builder
- Managing and sharing APIs
- Validating APIs
- Monitoring APIs
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- Monitoring FAQs
- Analyzing with reports
- Documenting your API
- Authoring your docs
- Publishing your docs
- Viewing documentation
- Using custom domains
- Publishing templates
- Publishing to the API Network
- Submission guidelines
- Managing your team
- Purchasing Postman
- Billing
- Configuring team settings
- Utilizing audit logs
- Onboarding checklist
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Microsoft AD FS
- Custom SAML in Azure AD
- Custom SAML in Duo
- Custom SAML in GSuite
- Custom SAML in Okta
- Custom SAML in Onelogin
- Custom SAML in Ping Identity
- Migrating to the current version of Postman
Postman API
The Postman API endpoints to help you integrate Postman within your development toolchain.
You can add new collections, update existing collections, update environments, and add and run monitors directly through the API. This enables you to programmatically access data stored in your Postman account.
You can get started with the API via the Run in Postman button at the top of the Postman API documentation and use the Postman app to send requests.
You will need an API key to access the Postman API.
The API is rate limited.
Generating a Postman API key
You need a valid API Key to send requests to the Postman API endpoints.
Navigate to the web dashboard. Select a workspace and open Integrations. Locate the Postman API and click View Details.
If you do not have any keys yet you will be prompted to create one. Click Generate API Key.
Enter a name for your key and click Generate API Key.
Copy your key and click Close.
Once you have keys generated you can manage them within your workspace.
Use API Key Settings to specify expiration periods for your keys.
Authentication
You will need to authenticate your requests to the Postman API by sending your API Key in the X-Api-Key header of every request you make.
Your API Key provides access to any Postman data you have permissions for.
You can store your API key in an environment variable—if you name it postman-api-key the Postman API collection will use it automatically
Rate Limits
API access rate limits are applied at a per-key basis in unit time.
Access to the API using a key is limited to 60 requests per minute. Every API response includes the following set of headers to identify the status of your consumption.
| Header | Description |
|---|---|
X-RateLimit-Limit |
The maximum number of requests that the consumer is permitted to make per minute. |
X-RateLimit-Remaining |
The number of requests remaining in the current rate limit window. |
X-RateLimit-Reset |
The time at which the current rate limit window resets in UTC epoch seconds. |
Free API calls with your Postman account
Your Postman account gives you a limited number of free Postman API calls per month. You can check your usage limits through the Postman API itself or the account usage page.
Next steps
You can combine the Postman API with Newman to integrate Postman with your CI/CD workflow.