Introduction to Postman API
The endpoints of the Postman API allow you to integrate Postman into your toolchain for development.
In postman API, we can create new collections, update environments, update existing collections, and directly add and run monitors. It helps you to access the stored data programmatically in your postman app.
Generating a Postman API Key
It is necessary to have an applicable API key to send the request.
- Go to the following link web dashboard.
- Choose your workspace.
- Select the Integrations tab and locate the Postman API and then select View Details.
- You will get the Generate API Key option if you don’t have any keys yet. Select the Generate API Key
- Enter the name of the key as per your choice and click on Generate API Key. Here I gave ‘user-development-key’.
- Don’t forget to copy the key. Then click close.
- Your key has been generated. You can now handle the keys within your workspace.
- You can delete and regenerate the key.
- Select on API Key Settings option to set the expiration period of your key.
Authentication
By submitting your API Key in the X-Api-Key header of any of your created requests, you will need to authenticate your requests to the Postman API.
This API key is used to give access to authorized data.
You can also store your API key in an environment variable with the name postman-api-key. The Postman API collection can access the API key automatically.
Rate Limits
60 requests per minute are required to access the API with the key.
Each response of an API contains the following set of headers to identify your consumption status.
| Header | Description |
|---|---|
| X-RateLimit-Limit | This header specifies the maximum number of requests the consumer is allowed to submit per minute. |
| X-RateLimit-Remaining | This header specifies the number of requests that are left in the current limit window. |
| X-RateLimit-Reset | This header defines the time at which the current rate limit window resets in UTC epoch seconds. |