The Postman API endpoints enable you to 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 by forking its collection. For more details, see the Postman API documentation.
You will need an API key to access the Postman API.
The Postman API is rate limited.
You need a valid API Key to send requests to the Postman API. To generate an API key:
Navigate to your Postman API Keys page. Select your avatar in the upper-right corner > Account Settings. Then select Postman API keys.
If you do not have any keys yet you will be prompted to create one. Select Generate API Key.
Enter a name for your key and select Generate API Key.
Copy your key, then Close.
Once you have API keys generated you can manage them within your workspace. Select ... next to a key to regenerate or delete it.
Use API Key Settings to specify expiration periods for your keys.
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.
You can also send the key as an
apikey URL query parameter. An API key sent as part of the header has a higher priority in case you send the key using both request header and query parameter.
Your API Key provides access to any Postman data you have permissions for.
You can store your API key in a variable. If you name it
postman_api_key, the Postman API collection will use it automatically
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.
||The maximum number of requests that the consumer is permitted to make per minute.|
||The number of requests remaining in the current rate limit window.|
||The time at which the current rate limit window resets in UTC epoch seconds.|
You can combine the Postman API with Newman to integrate Postman with your CI/CD workflow.