Integrate CI tools in Postman
Continuous integration and continuous delivery (CI/CD) are a core part of the API development workflow. Postman integrates with popular CI tools so you can view details about API builds in the same place where you define and test your API.
After you set up CI integration, you can view the status of builds or start a new build, all from within Postman. You can also run API tests created in Postman as part of your CI pipeline using the Postman CLI and the Postman API.
Integrations are available on Postman team plans. If you are on a Free individual plan, create a new team to get started with integrations. The maximum number of integrations you can use is determined by your Postman plan. Learn more about what's included with each plan.
Configure CI integration
To set up CI integration for your API, first set up your CI project and then connect Postman to your CI tool. After you set up CI integration, information for CI build jobs is available in Postman. Select Test and Automation for your API to view recent build jobs, see the build status, and even start a new build.
To connect your API to your CI project, see the steps for your CI tool:
Configure the Postman CLI for CI
Running API tests as part of your CI pipeline helps to keep expectations between your API producers and consumers in sync. The Postman CLI can also perform Postman API Governance and API Security checks as part of your CI pipeline (Enterprise teams only).
To run your API tests along with each build and, optionally, your API Governance and API Security checks, first generate the Postman CLI configuration code in Postman. Then add the configuration code to your CI project. Each time a CI build runs, the Postman CLI uses the Postman API to run the collections that contain your tests. You can view the results of your tests in Postman.
To configure the Postman CLI to run API tests, see the steps for your CI tool:
Last modified: 2024/10/04
