# llms.txt ## Site: Postman Docs URL: https://learning.postman.com/ ### Excerpt Official documentation for Postman, including API reference, tutorials, best practices, and troubleshooting guides for developers, testers, and API consumers. ### Purpose The Postman Docs provides comprehensive documentation, guides, and resources for using Postman, the leading API platform. It helps users design, test, document, and monitor APIs efficiently. --- ## Key Documentation Sections - [Get Started](https://learning.postman.com/getting-started/) - [API Reference](https://learning.postman.com/postman-api/) - [Collections](https://learning.postman.com/collections/) - [Testing & Automation](https://learning.postman.com/tests-and-scripts/) - [Monitoring](https://learning.postman.com/monitoring-your-api/) - [Integrations](https://learning.postman.com/integrations/) - [Postman Flows](https://learning.postman.com/postman-flows/) - [CLI](https://learning.postman.com/postman-cli/) - [Publishing APIs](https://learning.postman.com/publishing-your-api/) - [Reports](https://learning.postman.com/reports/) - [Support](https://learning.postman.com/support/) --- ## All Documentation Pages (Structured) ## administration - [admin-faqs](https://learning.postman.com/docs/administration/admin-faqs/): For administrative and team management frequently asked questions, check out Postman's Help Center. - [Set up and manage your Postman team](https://learning.postman.com/docs/administration/admin-overview/): Postman has a variety of tools you can use to set up, manage, and secure your Postman team. ### domain verification and capture - [Add and verify a domain](https://learning.postman.com/docs/administration/domain-verification-and-capture/add-and-verify-a-domain/): Domain verification is available with Postman Enterprise plans. As a Team Admin, you can add and verify a domain or subdomain. - [What happens to captured users and their data when domain capture is enabled?](https://learning.postman.com/docs/administration/domain-verification-and-capture/domain-capture-faqs/): Domain verification is available with Postman Enterprise plans. - [Benefits of enabling domain capture](https://learning.postman.com/docs/administration/domain-verification-and-capture/domain-capture-overview/): Domain verification is available with Postman Enterprise plans. - [View unclaimed accounts](https://learning.postman.com/docs/administration/domain-verification-and-capture/enable-domain-capture/): Domain capture is available with Postman Enterprise plans with the Advanced Security Administration add-on. ### enterprise - [About EU Data Residency](https://learning.postman.com/docs/administration/enterprise/about-eu-data-residency/): The Postman EU Data Residency provides a solution for customers in the European Union (EU) to use Postman in compliance with their internal privacy and... - [Enterprise features](https://learning.postman.com/docs/administration/enterprise/about-postman-enterprise/): Postman Enterprise plans are for organizations that need advanced identity management, security, and governance features as they design, build, test... - [Assign roles](https://learning.postman.com/docs/administration/enterprise/enterprise-onboarding/): To set up a productive Enterprise team in Postman, walk through the following general tasks. - [enterprise-overview](https://learning.postman.com/docs/administration/enterprise/enterprise-overview/): Postman Enterprise plans are designed for organizations that require and seek advanced identity management, security, and governance features for API design... - [For system-wide PKGs](https://learning.postman.com/docs/administration/enterprise/managing-enterprise-deployment/): Postman app versioning and the Postman Enterprise App are available with Postman Enterprise plans. ### managing your team - [View audit logs in the dashboard](https://learning.postman.com/docs/administration/managing-your-team/audit-logs/): Audit logs are available with Postman Enterprise plans. Audit logs display events related to your team, team members, and billing. - [byok-encryption](https://learning.postman.com/docs/administration/managing-your-team/byok-encryption/): BYOK Encryption is available on Postman Enterprise plans with the Advanced Security Administration add-on. - [Create new teams](https://learning.postman.com/docs/administration/managing-your-team/create-teams/): On a Postman free plan, teams of up to three can work together at no cost. - [Manage access to add-ons](https://learning.postman.com/docs/administration/managing-your-team/manage-team-product-access/): Add-on availability varies according to your Postman plan. - [Manage team workspaces](https://learning.postman.com/docs/administration/managing-your-team/manage-team-workspaces/): As a Super Admin or Team Admin, you can manage resources in your team workspaces in alignment with your organizational goals. - [Managing Postman API keys](https://learning.postman.com/docs/administration/managing-your-team/managing-api-keys/): Postman API key management is available with Postman Enterprise plans. - [Manage team members](https://learning.postman.com/docs/administration/managing-your-team/overview/): Some team options are only available on Postman Professional and Enterprise plans. Postman provides tools you can use to set up, manage, and secure your team. #### secret scanner - [Automatically replace secrets detected in public workspaces](https://learning.postman.com/docs/administration/managing-your-team/secret-scanner/how-secret-scanner-works/): The Secret Scanner scans public workspaces and published documentation to detect exposed secrets on all Postman plans. - [Benefits of Postman Secret Scanner](https://learning.postman.com/docs/administration/managing-your-team/secret-scanner/overview/): The Postman Secret Scanner scans public workspaces and published documentation to detect exposed secrets on all Postman plans. - [Resolve detected secrets](https://learning.postman.com/docs/administration/managing-your-team/secret-scanner/secret-scanner-dashboard/): The Secret Scanner dashboard is available with Postman Enterprise plans. - [Default patterns](https://learning.postman.com/docs/administration/managing-your-team/secret-scanner/secret-scanner-patterns/): Patterns help protect sensitive data and improve your team's security posture. #### team members - [Invite people to join your team](https://learning.postman.com/docs/administration/managing-your-team/team-members/invite-members/): Invite people to join your team, enable coworkers who aren't part of your team to view and send requests in specific collections... - [Manage workspace roles](https://learning.postman.com/docs/administration/managing-your-team/team-members/manage-roles/): Each team member must have one or more team roles assigned to them, which will enable them to perform different actions within your team. - [overview](https://learning.postman.com/docs/administration/managing-your-team/team-members/overview/): Some team options are only available with Postman Professional and Enterprise plans. - [Change team size](https://learning.postman.com/docs/administration/managing-your-team/team-members/scale-team/): Change your team size to accommodate more collaborators at any time in your billing cycle. You can also remove members as needed. - [Access team settings](https://learning.postman.com/docs/administration/managing-your-team/team-settings/): Your Team Settings enable you to manage items such as your team's publisher profile, discoverability, custom domains, authentication, and active invite links. - [Creating a group](https://learning.postman.com/docs/administration/managing-your-team/user-groups/): Groups are available with Postman Enterprise plans. With Postman groups, you can arrange users into groups that reflect your organizational structure. - [Set up Postman in your organization](https://learning.postman.com/docs/administration/onboarding-checklist/): To get started using Postman within your organization, you can walk through the following tasks to set your Postman team up for success. - [Team roles](https://learning.postman.com/docs/administration/roles-and-permissions/): Certain team options are only available with paid plans. To learn which roles are available with your plan, go to your web dashboard. ### scim provisioning - [Enabling SCIM in Microsoft Entra ID](https://learning.postman.com/docs/administration/scim-provisioning/configuring-scim-with-azure-ad/): Postman supports SCIM (System for Cross-domain Identity Management) provisioning through Microsoft Entra ID (formerly Azure Active Directory)... - [Set up SCIM in Okta with Postman Okta app](https://learning.postman.com/docs/administration/scim-provisioning/configuring-scim-with-okta/): Postman supports SCIM (System for Cross-domain Identity Management) provisioning through Okta with the Postman Okta app or the SCIM 2.0 test app (Header Auth). - [Enable SCIM in OneLogin](https://learning.postman.com/docs/administration/scim-provisioning/configuring-scim-with-onelogin/): Postman supports SCIM (System for Cross-domain Identity Management) provisioning through OneLogin with the Postman OneLogin app... - [SCIM features](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/): Provisioning with SCIM is available with Postman Enterprise plans. ### security - [Variables](https://learning.postman.com/docs/administration/security/developer-security/): As a developer creating APIs, you can secure your work in Postman using variables, leveraging 2FA, protecting your Postman API key... - [overview](https://learning.postman.com/docs/administration/security/overview/): Data security is a shared responsibility between Postman and its users. - [Single sign-On](https://learning.postman.com/docs/administration/security/team-security/): Postman's advanced administration features for teams include single sign-on support, audit logs, role-based access control (RBAC), configurable API encryption... ### sso - [Configuring single sign-on](https://learning.postman.com/docs/administration/sso/admin-sso/): SSO is available with Postman Enterprise plans. Single sign-on (SSO) for a Postman team is configured by a Team Admin. - [Configure SSO in Postman](https://learning.postman.com/docs/administration/sso/azure-ad/): SSO with Microsoft Entra ID is available with Postman Enterprise plans. - [Configuring SSO with custom SAML](https://learning.postman.com/docs/administration/sso/custom-saml/): SSO with custom SAML is available with Postman Enterprise plans. - [Setting up a custom SAML application in Duo](https://learning.postman.com/docs/administration/sso/duo/): SSO with Duo is available with Postman Enterprise plans. Note: An admin of your Duo organization must create the SAML application. - [Set up a custom SAML application in Google Workspace](https://learning.postman.com/docs/administration/sso/google-workspace/): SSO with Google Workspace is available with Postman Enterprise plans. To configure SSO with Google Workspace, create a custom SAML application. - [What are the advantages of SSO?](https://learning.postman.com/docs/administration/sso/intro-sso/): SSO is available with Postman Enterprise plans. Single sign-on (SSO) services enable you to manage your team's identity across all the SaaS products that... - [Configuring SSO with Microsoft AD FS](https://learning.postman.com/docs/administration/sso/microsoft-adfs/): SSO with Microsoft AD FS is available with Postman Enterprise plans. - [Configuring SSO with Okta](https://learning.postman.com/docs/administration/sso/okta/): SSO with Okta is available with Postman Enterprise plans. - [Configure SSO in Postman](https://learning.postman.com/docs/administration/sso/onelogin/): SSO with OneLogin is available with Postman Enterprise plans. To configure SSO with OneLogin, you can use the Postman app. - [Set up a custom SAML application in Ping Identity](https://learning.postman.com/docs/administration/sso/ping-identity/): SSO with Ping Identity is available with Postman Enterprise plans. - [Does enabling SSO for one team impact other teams that aren't on SSO?](https://learning.postman.com/docs/administration/sso/sso-faqs/): Following are frequently asked questions about configuring and using single sign-on (SSO) and SCIM (System for Cross-domain Identity Management) in Postman. - [Signing in to Postman with SSO](https://learning.postman.com/docs/administration/sso/user-sso/): SSO is available with Postman Enterprise plans. When your Team Admin has enabled single sign-on (SSO) for Postman... - [Who can perform team migration](https://learning.postman.com/docs/administration/team-merge/): Team migration is required when you merge one or more Postman teams into a single (typically company-authorized) account. ## agent mode - [Get started with Agent Mode](https://learning.postman.com/docs/agent-mode/overview/): Postman Agent Mode is currently in open beta on Basic and Professional plans and available to users who consent to using AI. ## api governance ### api definition - [Check rule violations in the API Builder](https://learning.postman.com/docs/api-governance/api-definition/api-definition-warnings/): Postman supports API governance and API security rules for API specifications in OpenAPI 3.1, OpenAPI 3.0, and OpenAPI 2.0 format. - [...](https://learning.postman.com/docs/api-governance/api-definition/openapi2/): Use Postman to identify any potential security and formatting issues when defining your API. OpenAPI 2. - [...](https://learning.postman.com/docs/api-governance/api-definition/openapi3/): Use Postman to identify any potential security and formatting issues when defining your API. Warnings for OpenAPI 3 For all APIs defined in OpenAPI 3.0 and 3. - [api-governance-overview](https://learning.postman.com/docs/api-governance/api-governance-overview/): API Governance is available with Postman Enterprise plans. API Security is available with Postman Enterprise plans with the API Builder add-on. ### api testing - [api-testing-warnings](https://learning.postman.com/docs/api-governance/api-testing/api-testing-warnings/): Postman applies security rules configured for your API requests when you send requests to any API using either the Postman web app or the Postman desktop app. - [Security misconfiguration](https://learning.postman.com/docs/api-governance/api-testing/security-warnings/): Use Postman to identify any potential security risks your API might be vulnerable to. ### configurable rules - [Configure governance rules](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/): Configurable API governance rules are available with Postman Enterprise plans. - [Add custom rules](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-api-governance-rules/): Configurable governance rules are available with Postman Enterprise plans. - [Turn configured rules on and off](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-api-security-rules/): Configurable security rules are available with Postman Enterprise plans with the API Builder add-on. - [Add a custom function](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-custom-governance-functions/): API Governance custom functions are available with Postman Enterprise plans. - [this approach won't work!](https://learning.postman.com/docs/api-governance/configurable-rules/spectral/): Spectral is a linting engine that helps you define custom rules and enforce them on JSON and YAML files. ## billing - [Manage your account, payment methods, and plan](https://learning.postman.com/docs/billing/billing-overview/): Postman provides several billing features that enable you to manage your team's payment methods, change your team's plan, and track your team's resource usage. - [Billing dashboard](https://learning.postman.com/docs/billing/billing/): Postman provides a self-serve billing process. Refer to the following sections for guidance on managing your account, plan, and payment. - [Configure your plan](https://learning.postman.com/docs/billing/buying/): Visit the pricing page to purchase a Postman Basic, Professional, or Enterprise plan. Select Buy Now for your chosen plan. - [View flows usage](https://learning.postman.com/docs/billing/flows-usage/): Postman provides tools to help you manage your team's usage of credits in Postman Flows. You get a certain number of credits each month. - [Team usage limits](https://learning.postman.com/docs/billing/resource-usage/): Postman provides you with a specified number of resources you can use each month, depending on your Postman plan. ## collaborating in postman - [Organize your APIs in workspaces](https://learning.postman.com/docs/collaborating-in-postman/api-collaboration-features/): Postman collaboration features enable you to build your APIs as a team and collaborate on APIs with business partners and developers across the planet. - [Understand how teams and workflows function in Postman](https://learning.postman.com/docs/collaborating-in-postman/collaborate-in-postman-overview/): Postman has a variety of features that enable you to collaborate with your team and API consumers. - [Teams and collaboration levels](https://learning.postman.com/docs/collaborating-in-postman/collaboration-concepts/): Postman simplifies and brings together the mechanics of API collaboration to help you interactively plan, develop, publish, and maintain APIs within your team... - [Use comments in Postman](https://learning.postman.com/docs/collaborating-in-postman/comments/): Commenting is one of Postman's most practical collaborative tools that can be used on both the publisher and consumer sides of APIs. - [Start a live session](https://learning.postman.com/docs/collaborating-in-postman/live-sessions/): Live Sessions is a beta feature available with Postman Free, Basic, Professional, and Enterprise plans. - [Public workspaces](https://learning.postman.com/docs/collaborating-in-postman/manage-public-elements/): The Manage public elements dashboard is available with Postman Enterprise plans. ### private api network - [Edit collections](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/managing-private-network/): Your Private API Network is available with Postman Enterprise plans. Managing APIs on your Private API Network requires the API Builder add-on. - [Organize with folders](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/organizing-private-network/): Your Private API Network is available with Postman Enterprise plans. Adding APIs to your Private API Network requires the API Builder add-on. - [Use your Private API Network](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/overview/): Your Private API Network is available with Postman Enterprise plans. Adding and managing APIs on your Private API Network requires the API Builder add-on. - [Request to add elements](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/private-network-requests/): Your Private API Network is available with Postman Enterprise plans. Requesting to add APIs to your Private API Network requires the API Builder add-on. - [Getting started](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/publish-private-network-elements-with-api/): Your Private API Network is available with Postman Enterprise plans. Adding APIs to your Private API Network requires the API Builder add-on. - [Explore your Private API Network](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/use-private-network/): Your Private API Network is available with Postman Enterprise plans. Viewing APIs on your Private API Network requires the API Builder add-on. ### public api network - [Benefits of the Postman API Network](https://learning.postman.com/docs/collaborating-in-postman/public-api-network/public-api-network-overview/): The Postman API Network enables API publishers to share their public workspaces, collections, APIs, and Flows with their API's consumers. - [Request Editor access](https://learning.postman.com/docs/collaborating-in-postman/requesting-access-to-elements/): This topic provides an overview of managing access to Postman workspaces, the elements they contain... - [Share your Postman workspace](https://learning.postman.com/docs/collaborating-in-postman/sharing/): Postman enables you to collaboratively iterate on your APIs with developers, testers, architects, and other business stakeholders. - [Find teams within your organization](https://learning.postman.com/docs/collaborating-in-postman/use-teams/): Collaborate with others in Postman using internal workspaces. You can find a team within your organization or join by other means enabled by your organization. ### using version control - [Create pull requests](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/creating-pull-requests/): Contribute to a collection or environment you forked with a pull request (Postman Flows doesn't support this feature). - [Create a fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/): A fork is a new instance of an element. When you modify a fork, its parent element remains unchanged. In Postman, you can fork collections and environments. - [Review pull requests](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/reviewing-pull-requests/): If you're tagged as a reviewer on a pull request, you can view the changes, comment, approve or decline the request... - [version-control-overview](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/version-control-overview/): Postman provides version control for your API collections and environments so you can iteratively and collaboratively build your APIs in Postman. - [Watch a pull request](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/watching-pull-requests/): The watch option enables you to receive an in-app notification when a team member modifies the pull request. ### using workspaces - [Create a new workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/create-workspaces/): When you first sign in to Postman, an internal workspace is automatically created for you. #### internal workspaces - [Edit workspace details](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/manage-workspaces/): Whether you're a team or admin user of Postman workspaces, you have many options to establish and enhance collaboration in your workspaces. - [overview](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/overview/): Internal workspaces let you organize your work in Postman and collaborate privately with your team. You can set them to be visible by you only or your team. - [Tag a workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/use-workspaces/): When you first open Postman, you will be in your default internal workspace. You can create more workspaces for your use and to work with teammates. - [Post a workspace update](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/workspace-updates/): Workspace updates keep your team and your users aware of your API changes. - [Workspace types](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/overview/): Workspaces enable you to organize your Postman work and collaborate with teammates. #### partner workspaces - [Collaborate as a Team Member](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/collaborate/): Partner Workspaces are available with Postman Professional and Enterprise plans. - [Manage users and roles](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/manage/): Partner Workspaces are available with Postman Professional and Enterprise plans. - [Migrate your Partner Workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/migrate/): Starting in May 2025, you can create team-to-team Partner Workspaces. - [Multi-partner mode](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/multipartner-workspaces/): Partner Workspaces are available with Postman Professional and Enterprise plans. - [overview](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/overview/): Partner Workspaces are available with Postman Professional and Enterprise plans. - [Create a Partner Workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/setup/): From May 2025, you can begin creating team-to-team Partner Workspaces, which ensures easier and more secure collaboration between you and your partners. - [Make your team profile public](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/public-workspaces/): Anyone in the Postman community can access a public workspace. ## collections - [Get started with collections](https://learning.postman.com/docs/collections/collections-overview/): Postman Collections are portable sets of API requests that you can reuse, automate, and share with others. ### performance testing - [Configure a performance test](https://learning.postman.com/docs/collections/performance-testing/performance-test-configuration/): Use the Collection Runner to test the performance of your API with the same requests and collections you use for functional API tests. - [Run a performance test with a data file](https://learning.postman.com/docs/collections/performance-testing/performance-test-data-files/): When you configure a performance test, you specify a number of virtual users. - [View top errors](https://learning.postman.com/docs/collections/performance-testing/performance-test-errors/): During a performance test, requests that result in a response other than a 2xx status code are tracked as errors. - [View performance metrics](https://learning.postman.com/docs/collections/performance-testing/performance-test-metrics/): During a performance test, all requests are sent from your computer where you are running the Postman desktop app. - [Test API performance with virtual users](https://learning.postman.com/docs/collections/performance-testing/testing-api-performance/): Test the performance of your APIs with the Postman desktop app. Simulate user traffic by automatically sending requests in the app. ### running collections - [Set the next request](https://learning.postman.com/docs/collections/running-collections/building-workflows/): By default, when you run a collection, Postman runs all requests in the order they appear in your collection. - [Create a webhook](https://learning.postman.com/docs/collections/running-collections/collection-webhooks/): A webhook provides a way to automatically send data from one application to another. - [Configure a collection run](https://learning.postman.com/docs/collections/running-collections/intro-to-collection-runs/): Send some or all of the API requests in a Postman Collection in the order you choose with the Collection Runner. - [running-collections-overview](https://learning.postman.com/docs/collections/running-collections/running-collections-overview/): Run Postman Collections to test and interact with your APIs. In Postman, a collection can be a group of saved requests, a workflow, or a test suite. - [scheduling-collection-runs-monitors](https://learning.postman.com/docs/collections/running-collections/scheduling-collection-runs-monitors/): Automate collection runs using Postman monitors. Create a new monitor, select a collection, and configure a schedule. - [About scheduled collection runs](https://learning.postman.com/docs/collections/running-collections/scheduling-collection-runs/): Instead of running collections manually, Postman can run collections for you on a schedule. - [Scheduled collection run summary](https://learning.postman.com/docs/collections/running-collections/viewing-scheduled-collection-runs/): Postman can run your collections on a schedule at specific times each day or week. For example, you may want to run a collection that tests your API every day. - [Use a local data file](https://learning.postman.com/docs/collections/running-collections/working-with-data-files/): When you configure a manual or scheduled collection run, you can choose to use custom data for each iteration. ### use collections - [Add a request to an empty collection](https://learning.postman.com/docs/collections/use-collections/add-requests-to-collections/): After you create a Postman Collection, you can use it to save and organize API requests. Use any of the methods below to add requests to a collection. - [Share a collection](https://learning.postman.com/docs/collections/use-collections/collaborate-with-collections/): Collaborate on Postman Collections with your team and other Postman users. - [collection-overview-tab](https://learning.postman.com/docs/collections/use-collections/collection-overview-tab/): A collection's Overview tab provides a summary of the collection's purpose, recent activity, and related elements. - [Create a new collection](https://learning.postman.com/docs/collections/use-collections/create-collections/): Create a Postman Collection to save and share your favorite requests, to group requests you use for testing an API, or to document your API. - [Collection basics](https://learning.postman.com/docs/collections/use-collections/manage-collections/): Save, organize, and find all of your API requests in Postman Collections. - [Create new collections](https://learning.postman.com/docs/collections/use-collections/use-collections-overview/): A collection is one of the fundamental elements in Postman. ### using newman cli - [Get started in Newman](https://learning.postman.com/docs/collections/using-newman-cli/command-line-integration-with-newman/): Newman is a command-line tool for running Postman Collections. Use Newman to run and test collections from the command line instead of in the Postman app. - [Prerequisites](https://learning.postman.com/docs/collections/using-newman-cli/continuous-integration/): Use Newman and the Postman API to run Postman Collections in your continuous integration (CI) environment. First install Node. - [Install Newman](https://learning.postman.com/docs/collections/using-newman-cli/installing-running-newman/): Newman is built on Node.js. To get started, first install Node.js, then install Newman. - [Install Newman in Jenkins](https://learning.postman.com/docs/collections/using-newman-cli/integration-with-jenkins/): Jenkins is an open source automation server that can act as a continuous integration (CI) server or a continuous delivery (CD) hub. - [Run Postman tests with Travis CI](https://learning.postman.com/docs/collections/using-newman-cli/integration-with-travis/): Continuous integration and continuous delivery (CI/CD) is a development practice that encourages developers to commit their code changes to a shared repository... - [Use built-in reporters](https://learning.postman.com/docs/collections/using-newman-cli/newman-built-in-reporters/): Newman has built-in reporters you can use to generate reports for your collection runs. - [Build custom reporters](https://learning.postman.com/docs/collections/using-newman-cli/newman-custom-reporters/): Generate reports for your collection runs in Newman with custom and external reporters. - [newman-file-uploads](https://learning.postman.com/docs/collections/using-newman-cli/newman-file-uploads/): Newman supports file uploads so you can send test data (form data or a binary) with an API request. - [Basic options](https://learning.postman.com/docs/collections/using-newman-cli/newman-options/): Use Newman's command line options to customize your collection runs. - [Use Newman with Docker on macOS and Ubuntu](https://learning.postman.com/docs/collections/using-newman-cli/newman-with-docker/): Docker is a platform for building and running applications in a virtual environment. You can use Newman to run your Postman Collections in a Docker container. ## design apis ### api builder - [Create an API](https://learning.postman.com/docs/design-apis/api-builder/creating-an-api/): Go to one of your workspaces and use the Postman API Builder to create an API. #### deploy apis - [Connect to an API gateway](https://learning.postman.com/docs/design-apis/api-builder/deploy-apis/overview/): Postman enables you to manage your API deployments by connecting to an API gateway. #### develop apis - [Add a collection to your API](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/adding-api-elements/): Your API in Postman can include more than an API definition. You can add elements such as collections to help you document and test your API. - [Supported API definition formats](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/defining-an-api/): Create the structure of your API using the API definition. The API definition can consist of one or multiple files. - [Generating server code](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/generating-server-code/): With server code generation, you can generate server-side boilerplate code from your OpenAPI 3.0 specification. - [Edit your API definition](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/overview/): Use Postman's API-first tools to develop your API definition and build out your API with tests, documentation, and server-side code. - [Validating requests and responses](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/validating-elements-against-schema/): Validate collections that are linked to an API to make sure the API implementation is consistent with the API definition. - [Import an API specification](https://learning.postman.com/docs/design-apis/api-builder/importing-an-api/): Import an existing API specification into the Postman API Builder. - [Share APIs](https://learning.postman.com/docs/design-apis/api-builder/managing-apis/): When you define your APIs in Postman using the API Builder, each API is associated with a workspace. #### observe apis - [Connecting to Datadog APM](https://learning.postman.com/docs/design-apis/api-builder/observe-apis/datadog-apm/): Datadog is an application performance management (APM) service that provides visibility for cloud-scale applications. - [Connecting to New Relic APM](https://learning.postman.com/docs/design-apis/api-builder/observe-apis/new-relic-apm/): New Relic is an application performance management (APM) solution to monitor real-time and trending data for your processes or web apps. - [View APM metrics](https://learning.postman.com/docs/design-apis/api-builder/observe-apis/overview/): Learn how to integrate popular API observability tools with Postman to track API performance, identify opportunities for API optimization... - [Designing and developing your API](https://learning.postman.com/docs/design-apis/api-builder/overview/): With the API Builder, you can connect various Postman elements of your API development lifecycle to your API definition, such as collections, documentation... - [Adding API tests](https://learning.postman.com/docs/design-apis/api-builder/testing-an-api/): Testing is a critical part of the API development process. You can create a collection that has your API tests and link it to your API. #### versioning an api - [Publishing an API to consumers](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/api-versions/): When you're ready to share the latest changes to your API with consumers, you can publish a version. - [Separate APIs with files](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/connecting-multiple-apis/): Connect more than one API in Postman to the same Git repository. For each API you want to connect, repeat the process to set up the Git integration. - [Work with branches](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/managing-git-changes/): After you connect to a remote Git repository, you can use Postman to make changes to your API and collaborate with others. - [API version control workflow](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/overview/): Git integrations are available with Postman team plans. If you are on a Free individual plan, create a new team to connect to a remote repository. - [Using a cloud-hosted repository overview](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/using-cloud-git-repo/): Connect your API to a cloud-hosted Git repository to sync your API definition and collections between Postman and the repository. - [Using an on-premises repository overview](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/using-on-prem-git-repo/): GitHub Enterprise Server, GitLab Self-Managed, and Azure DevOps Server (hosted on-premises) integrations are available with Postman Enterprise plans with the... ### collections - [Add body data types](https://learning.postman.com/docs/design-apis/collections/add-properties-to-body-data/): Add body data to your API requests to send a data payload along with the request. - [add-properties-to-parameters-and-headers](https://learning.postman.com/docs/design-apis/collections/add-properties-to-parameters-and-headers/): Add types to parameters and headers. Types can include data type, format, default value, and possible values. You can also specify if a component is required. - [Generate OpenAPI specifications from a collection](https://learning.postman.com/docs/design-apis/collections/generate-specifications/): Generate an OpenAPI 3.0 specification from a collection in Spec Hub. - [Define types in your collections](https://learning.postman.com/docs/design-apis/collections/overview/): Define types in your collection to add more details to request parameters, headers, and bodies in an HTTP collection. - [View types for parameters, headers, and body data](https://learning.postman.com/docs/design-apis/collections/view-properties-and-documentation/): Anyone with access to a collection with types can view them for parameters, headers, and body data. They can also view types in the collection's documentation. ### mock apis - [Use Postman variables with mock servers](https://learning.postman.com/docs/design-apis/mock-apis/create-dynamic-responses/): Postman mock servers return static responses defined in saved examples. - [How it works](https://learning.postman.com/docs/design-apis/mock-apis/matching-algorithm/): When you create a mock server, Postman associates a collection (and optionally an environment) with the new mock server. - [Call a mock server](https://learning.postman.com/docs/design-apis/mock-apis/mock-server-calls/): After setting up a mock server, you can begin making calls to its URL. - [Get started with mock servers in Postman](https://learning.postman.com/docs/design-apis/mock-apis/overview/): Use a mock server to simulate a server for your API requests without having to configure one. You can use any HTTP collection to set up a mock server. - [Create mock servers](https://learning.postman.com/docs/design-apis/mock-apis/set-up-mock-servers/): Create mock servers in Postman to help with API development and testing. #### tutorials - [Set up a collection for mocking](https://learning.postman.com/docs/design-apis/mock-apis/tutorials/mock-with-api/): Set up a mock server to simulate the behavior of a real API for development or testing purposes. - [Create a new collection and request](https://learning.postman.com/docs/design-apis/mock-apis/tutorials/mock-with-examples/): Mock servers simulate an API server by returning predefined data, so you can develop or test an API before it's ready for production. - [Tutorials](https://learning.postman.com/docs/design-apis/mock-apis/tutorials/overview/): These tutorials show you how to get started with Postman’s mock servers and make the most of their features. - [Design APIs with collections](https://learning.postman.com/docs/design-apis/overview/): Postman offers a variety of ways to design and develop your APIs. ### specifications - [About multi-file specifications](https://learning.postman.com/docs/design-apis/specifications/add-files-to-a-specification/): With a multi-file API specification in Spec Hub, your specification can span across multiple files and folders, improving its organization and management. - [Show specifications in the sidebar](https://learning.postman.com/docs/design-apis/specifications/create-a-specification/): Create a specification in Spec Hub to design and test your API's structure. You can create a specification in OpenAPI 3.0 or AsyncAPI 2.0 format. - [Navigate your specification](https://learning.postman.com/docs/design-apis/specifications/edit-a-specification/): Edit your specification to update the structure and design of your API. - [Generate collections from a specification](https://learning.postman.com/docs/design-apis/specifications/generate-collections/): Generate a collection from a specification to share it with your team members and consumers. - [import-a-specification](https://learning.postman.com/docs/design-apis/specifications/import-a-specification/): Import an existing OpenAPI 3.0 or AsyncAPI 2.0 specification in Spec Hub. Import a single or multi-file OpenAPI 3. - [Design your API in a specification](https://learning.postman.com/docs/design-apis/specifications/overview/): Take an API-first approach to development with Spec Hub in Postman. You can create OpenAPI 3.0 or AsyncAPI 2. - [View syntax errors in your specification](https://learning.postman.com/docs/design-apis/specifications/validate-a-specification/): As you edit your specification, Postman identifies syntax errors, such as wrong data types and nesting... - [view-live-documentation](https://learning.postman.com/docs/design-apis/specifications/view-live-documentation/): Postman displays a live preview of your API's documentation if you're editing an OpenAPI 3.0 or AysncAPI 2.0 specification. ## developer - [Generate code programmatically](https://learning.postman.com/docs/developer/code-generators/): Generate client code for your API collections in Postman. Postman's Node. - [Access the API convertors](https://learning.postman.com/docs/developer/collection-conversion/): The API convertors enable you to convert API definitions in OpenAPI, Swagger, RAML, GraphQL, or WSDL schema formats into the Postman Collection Format. - [Accessing the Collection SDK](https://learning.postman.com/docs/developer/collection-sdk/): The Collection SDK is a Node.js module that enables you to work with Postman Collections and build them dynamically into your API project pipeline. - [Using the Echo API](https://learning.postman.com/docs/developer/echo-api/): Use the Postman Echo service to test requests in Postman. ### postman api - [Generate a Postman API key](https://learning.postman.com/docs/developer/postman-api/authentication/): The Postman API and Postman CLI use API keys for authentication. A Postman API key tells the server that the request came from you. - [Postman API features](https://learning.postman.com/docs/developer/postman-api/intro-api/): Use the Postman API to programmatically manage your Postman assets and integrate Postman into your development toolchain. - [Get your API key](https://learning.postman.com/docs/developer/postman-api/make-postman-api-call/): The Postman API enables you to programmatically access data stored in your Postman account. - [postman-api-rate-limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/): Postman's API access rate limits are applied at a per-user basis in unit time. Access to the API using a key is limited to 300 requests per minute. #### postman mcp server - [Use cases](https://learning.postman.com/docs/developer/postman-api/postman-mcp-server/overview/): The Postman Model Context Protocol (MCP) server enables AI agents like Claude, Cursor, and VS Code to help you manage your Postman resources... - [Tips and best practices](https://learning.postman.com/docs/developer/postman-api/postman-mcp-server/postman-mcp-server-tips/): With the Postman MCP server, you empower AI agents (such as Cursor, Claude, or VS Code) to manage your Postman resources. - [Remote server](https://learning.postman.com/docs/developer/postman-api/postman-mcp-server/set-up-postman-mcp-server/): The Postman MCP Server supports both remote servers through streamable HTTP and local servers with STDIO. The remote server is available at https://mcp.postman. - [resources-intro](https://learning.postman.com/docs/developer/resources-intro/): Use a variety of Postman developer resources in your projects, including APIs and libraries. - [Accessing the Postman Runtime library](https://learning.postman.com/docs/developer/runtime-library/): The Postman Runtime library is an open-source Node.js project you can use for low-level configuration over request sending in your API development and testing... ### vs code extension - [Access certificates](https://learning.postman.com/docs/developer/vs-code-extension/certificates/): Add a custom CA certificate in the Postman VS Code extension to connect to an API that uses a certificate registered with an internal certificate registry. - [Write documentation](https://learning.postman.com/docs/developer/vs-code-extension/document/): When you create a collection, Postman automatically generates basic documentation that includes details about requests and sample code in various client... - [feedback](https://learning.postman.com/docs/developer/vs-code-extension/feedback/): Share your feedback to help improve the Postman VS Code extension. To create a bug or feature request, do the following: 1. #### import data - [Import environment variables](https://learning.postman.com/docs/developer/vs-code-extension/import-data/import-environment-variables/): Import .env files with environment variables from your API project into new environments in Postman. Then you can sync changes from your . - [Import Postman data](https://learning.postman.com/docs/developer/vs-code-extension/import-data/import-postman-data/): Import collections and environments that were exported from Postman. You can also import requests using a cURL command. - [Import data into the VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/import-data/overview/): With the Postman VS Code extension, you can import collection and environments that you exported from Postman. - [Application requirements](https://learning.postman.com/docs/developer/vs-code-extension/install/): To get started with Postman in VS Code, choose the supported application where you'd like to install the Postman VS Code extension. - [Add environment variables](https://learning.postman.com/docs/developer/vs-code-extension/manage-environments/): Add a set of variables to an environment that you can use in your requests. Variables are reusable values you can use in your API requests and scripts. - [Install](https://learning.postman.com/docs/developer/vs-code-extension/overview/): With the Postman VS Code extension, you can develop and test your APIs in Postman right from Visual Studio Code and other supported applications. - [Create the Postman MCP server integration](https://learning.postman.com/docs/developer/vs-code-extension/postman-mcp-server/): With the Postman VS Code extension, you can automatically integrate the Postman Model Context Protocol (MCP) server with your AI agent in VS Code. - [Send HTTP API requests](https://learning.postman.com/docs/developer/vs-code-extension/send-requests/): The Postman VS Code extension enables you to create and send HTTP and multi-protocol requests, or your request history. - [Manage access to Postman resources](https://learning.postman.com/docs/developer/vs-code-extension/share/): Collaborate in Postman with the Postman VS Code extension by sharing your collections, environments, and workspaces with your team. #### tests and scripts - [Configure a collection run](https://learning.postman.com/docs/developer/vs-code-extension/tests-and-scripts/collection-runner/): With the Postman VS Code extension, you can use the Collection Runner to manually run a collection's or folder's requests in a specific sequence. - [Use scripts to test your APIs](https://learning.postman.com/docs/developer/vs-code-extension/tests-and-scripts/overview/): With the Postman VS Code extension, you can write scripts and import packages in your pre-request and post-response scripts. - [Reuse scripts with the package library](https://learning.postman.com/docs/developer/vs-code-extension/tests-and-scripts/packages/): With the Postman VS Code extension, you can import packages from your team's Package Library into scripts in your internal workspaces. - [Test your API using scripts](https://learning.postman.com/docs/developer/vs-code-extension/tests-and-scripts/test/): Use the Postman VS Code extension to test your API's functionality. - [Add HTTP requests to a collection](https://learning.postman.com/docs/developer/vs-code-extension/use-collections/): With the Postman VS Code extension, you can create new collections to group HTTP requests. ## getting started ### account - [Link your account to Postman](https://learning.postman.com/docs/getting-started/account/manage/): Signing up for a Postman account enables you to begin collaborating with others from the outset. On paid plans, you can find discoverable teams you can join. - [overview](https://learning.postman.com/docs/getting-started/account/overview/): With a free Postman account, you can access your work from different machines and collaborate with others on your API projects. - [Set up two-factor authentication](https://learning.postman.com/docs/getting-started/account/settings/): Manage account settings, including two-factor authentication, your email address, password, and workspace data on your account settings page. ### basics - [Get started with Postbot](https://learning.postman.com/docs/getting-started/basics/about-postbot/): Postbot is your AI assistant for API workflows in Postman. - [Postman Desktop Agent](https://learning.postman.com/docs/getting-started/basics/about-postman-agent/): The Postman Agent enables you to send API requests when you're using the Postman web app. - [Header](https://learning.postman.com/docs/getting-started/basics/navigating-postman/): Postman has a variety of tools, views, and controls to help you manage your API projects. - [Find your way around Postman](https://learning.postman.com/docs/getting-started/basics/postman-basics/): This section covers the basic features of Postman that help you send API requests, share your work with others... - [Collections](https://learning.postman.com/docs/getting-started/basics/postman-elements/): As a comprehensive API development platform, Postman helps you organize and document your work and complete different phases of the API development lifecycle. - [Understanding sync states](https://learning.postman.com/docs/getting-started/basics/syncing/): Postman automatically syncs changes across all devices that are linked to your account, including edits, updates, additions, or deletions. - [Accessing the lightweight API Client](https://learning.postman.com/docs/getting-started/basics/using-api-client/): The lightweight Postman API Client is a space where you can work if you're using the Postman desktop app and not connected to Postman servers. - [Entering the Scratch Pad](https://learning.postman.com/docs/getting-started/basics/using-scratch-pad/): The Scratch Pad is a space where you can work if you're using the Postman desktop app and not connected to Postman servers. - [work-with-your-team](https://learning.postman.com/docs/getting-started/basics/work-with-your-team/): Postman offers a range of features to facilitate collaboration with your team members and API consumers. ### first steps - [Next steps](https://learning.postman.com/docs/getting-started/first-steps/creating-the-first-collection/): To create a new collection, in this example, you'll start by creating a new request first. You can create a new request from the sidebar in Postman. - [Find public APIs](https://learning.postman.com/docs/getting-started/first-steps/exploring-public-api-network/): The Postman API Network is the world's largest network of public APIs. - [get-postman](https://learning.postman.com/docs/getting-started/first-steps/get-postman/): Download the Postman app for macOS, Windows, or Linux. Postman is the API platform for using, building, and testing APIs. - [next-steps](https://learning.postman.com/docs/getting-started/first-steps/next-steps/): In summary, you've sent a request, written a test, and saved requests to collections. - [overview](https://learning.postman.com/docs/getting-started/first-steps/overview/): Follow this quick guide to get started using Postman. - [Send an API request](https://learning.postman.com/docs/getting-started/first-steps/sending-the-first-request/): Postman's API client enables you to create and send API requests, including HTTP, GraphQL, and gRPC requests. - [Sign up for Postman](https://learning.postman.com/docs/getting-started/first-steps/sign-up-for-postman/): Before you sign up for a Postman account, download the Postman desktop app or access Postman on the web. To learn more, go to Get the Postman app. - [write-your-first-test](https://learning.postman.com/docs/getting-started/first-steps/write-your-first-test/): API tests are a way to ensure that your API is behaving as you expect it to. ### importing and exporting - [Export collections](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/): Export your Postman data, including collections, environments, global variables, and data dumps, as JSON files. - [importing-and-exporting-overview](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-and-exporting-overview/): Postman can import and export Postman data, including collections, environments, globals, and data dumps. - [Import a cURL command into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-curl-commands/): cURL is a popular command-line tool for making HTTP requests. - [Import Postman data](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data/): Import collections, API definitions, and other data files so you can work with them in Postman. - [Import from a local Git repository](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-git/): If you have API definitions, API specifications, collections, or environments in a Git repository, you can import the data so you can work with it in Postman. - [Export files from Hoppscotch](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-hoppscotch/): Hoppscotch is an open-source API development ecosystem used for testing APIs. Postman can import collection and environment files exported from Hoppscotch. - [Export files from Insomnia](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-insomnia/): Insomnia is an open-source desktop application for creating APIs. Postman can import requests, environments, and other data exported from Insomnia. - [Get your New Relic API key](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-new-relic/): Importing from New Relic is available with Postman Free team plans. You can create a free account and then create a new team to try out this feature. - [Export a SoapUI project](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-soapui/): SoapUI is an API testing tool that supports SOAP and REST services. - [Import a Swagger API](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-swagger/): Postman can import APIs created with the Swagger tool suite and any API that follows a supported version of the OpenAPI specification. - [Export files from Thunder Client](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-thunder-client/): Thunder Client is an API client extension in VS Code for testing and working with APIs. ### installation - [Manage your Postman installation](https://learning.postman.com/docs/getting-started/installation/install-overview/): Postman provides several installation options and enables you to customize your user experience. - [Install Postman on Windows](https://learning.postman.com/docs/getting-started/installation/installation-and-updates/): To get the latest version of the Postman desktop app, visit the Download Postman page and select the option for your operating system. - [Make your profile public](https://learning.postman.com/docs/getting-started/installation/postman-profile/): Once you create your Postman account, you can customize your Postman profile and share about yourself and your best work. - [Configuring the default proxy](https://learning.postman.com/docs/getting-started/installation/proxy/): A proxy is an intermediary server that sits between a client application (like Postman) and the destination server that the client is communicating with (like... - [General](https://learning.postman.com/docs/getting-started/installation/settings/): Postman automatically chooses default values for some settings so you can get right to work. - [Windows](https://learning.postman.com/docs/getting-started/installation/system-requirements/): The following are the system requirements for the Postman desktop app on Windows, Mac, and Linux operating systems. - [overview](https://learning.postman.com/docs/getting-started/overview/): Welcome! This section of the Postman Docs contains topics about how to get started using Postman. ### postman trials - [Trial length](https://learning.postman.com/docs/getting-started/postman-trials/enterprise-plus-faq/): Learn more about how to take full advantage of Postman's Enterprise+ Trial, and how to get support if you experience any issues. - [overview](https://learning.postman.com/docs/getting-started/postman-trials/overview/): The Enterprise+ Trial can give you 30 days of full-feature access to Postman’s most powerful collaboration tools. ## insights - [Redact your own data for Repro Mode](https://learning.postman.com/docs/insights/customize/): The Postman Insights Agent observes your API traffic to automatically populate your endpoints inside your Insights project. ### data - [Access](https://learning.postman.com/docs/insights/data/access/): Learn how and why Postman accesses, processes, transmits, and stores the data generated during tests. - [daemonset-security](https://learning.postman.com/docs/insights/data/daemonset-security/): DaemonSet (multi-namespace) uses the Kubernetes API and the Container Runtime Interface (CRI) to obtain information on the running pods and containers. - [overview](https://learning.postman.com/docs/insights/data/overview/): Postman Insights practices responsible data access and storage. - [Default keys](https://learning.postman.com/docs/insights/data/redactions/): Postman Insights treats handling of user data seriously. - [When Repro Mode is off](https://learning.postman.com/docs/insights/data/repro-mode-security/): When Repro Mode is enabled, the Postman Insights Agent uploads the header and payload data from requests with errors. - [Locate your error](https://learning.postman.com/docs/insights/debug/): Repro Mode aims to make it seamless to rerun requests using real user data from production. - [Why Insights if I already use New Relic and Sentry?](https://learning.postman.com/docs/insights/faq/): The following are some frequently asked questions you might have about Postman Insights. ### get started - [Requirements](https://learning.postman.com/docs/insights/get-started/beanstalk/): The Postman Insights Agent listens to the traffic arriving at the cluster service you want to monitor and automatically populates your Insights project with... - [demo](https://learning.postman.com/docs/insights/get-started/demo/): Explore a demo of Postman Insights capabilities on a local Docker instance. A prerequisite for the demo is that you've locally installed and configured Docker. - [Requirements](https://learning.postman.com/docs/insights/get-started/ec2/): The Postman Insights Agent listens to the traffic arriving at the service you want to monitor and automatically populates your Insights project with endpoints. - [Requirements](https://learning.postman.com/docs/insights/get-started/ecs/): The Postman Insights Agent listens to the traffic arriving at the cluster service you want to monitor and automatically populates your Insights project with... #### kubernetes - [Requirements](https://learning.postman.com/docs/insights/get-started/kubernetes/daemonset/): Install the Postman Insights Agent as a DaemonSet if you want to install it in multiple services at once, for example... - [overview](https://learning.postman.com/docs/insights/get-started/kubernetes/overview/): The Postman Insights Agent listens to the traffic arriving at the cluster service you want to monitor and automatically populates your Insights project with... - [Requirements](https://learning.postman.com/docs/insights/get-started/kubernetes/sidecar/): After you create an Insights project and select Start with Kubernetes, you can begin your Insights Agent installation as a sidecar. - [Add Insights to your workspace](https://learning.postman.com/docs/insights/get-started/overview/): To get started with Postman Insights, install the Postman Insights Agent and allow it to watch your API traffic. - [Supported platforms](https://learning.postman.com/docs/insights/overview/): Postman Insights is available with Free, Basic, and Professional plans outside the EU as part of a free introductory period. ### reference #### agent - [Usage](https://learning.postman.com/docs/insights/reference/agent/apidump/): The apidump command captures and stores a sequence of requests and responses to a service by observing network traffic. See Examples. - [Usage](https://learning.postman.com/docs/insights/reference/agent/completion/): The completion command generates the autocompletion script for The Postman Insights Agent in the specified shell. - [Usage](https://learning.postman.com/docs/insights/reference/agent/ecs-add/): The ecs add command collects information to add the Postman Insights Agent container to an ECS task. See Examples. For help, use -h or --help. - [Usage](https://learning.postman.com/docs/insights/reference/agent/ecs-cf-fragment/): The ecs cf-fragment command prints a code fragment that can be inserted into a CloudFormation template to add the Postman Insights Agent as a sidecar container. - [Usage](https://learning.postman.com/docs/insights/reference/agent/ecs-task-def/): The ecs task-def command prints a task definition to be added to an ECS cluster to run the Postman Insights Agent as a daemon in host-networking mode on every... - [Usage](https://learning.postman.com/docs/insights/reference/agent/kube-helm-fragment/): The kube helm-fragment command prints a container definition that can be inserted into a Helm Chart template to add the Postman Insights Agent as a sidecar... - [Flags](https://learning.postman.com/docs/insights/reference/agent/kube-inject/): The kube inject command injects the Postman Insights Agent into a Kubernetes deployment and output the result on the command line into a file. See Examples. - [Usage](https://learning.postman.com/docs/insights/reference/agent/kube-run/): The kube run command runs the Postman Insights Agent in your Kubernetes cluster as a DaemonSet to collect and send data to Postman Insights (supported for... - [Usage](https://learning.postman.com/docs/insights/reference/agent/kube-secret/): The kube secret command generates a Kubernetes Secret manifest containing your Postman API key, and output the result to standard output or a file. - [Usage](https://learning.postman.com/docs/insights/reference/agent/kube-tf-fragment/): The kube tf-fragment command prints a Terraform (HCL) code fragment that can be inserted into a Terraform kubernetesdeployment resource spec to add the... - [overview](https://learning.postman.com/docs/insights/reference/agent/overview/): Explore the different commands to use with the Postman Insights Agent. #### app - [Configure Insights alerts](https://learning.postman.com/docs/insights/reference/app/alerts-tab/): The Postman Insights Alerts tab provides a centralized alert system for endpoint error rates to help you catch and fix critical issues. - [diagnostics-tab](https://learning.postman.com/docs/insights/reference/app/diagnostics-tab/): The Diagnostics tab displays the metadata of the agents that are running and sending traffic for a service. - [Search and filter endpoints](https://learning.postman.com/docs/insights/reference/app/endpoints-tab/): The Endpoints tab lists all the API endpoints that the Postman Insights Agent has observed for your service. - [Errors overview](https://learning.postman.com/docs/insights/reference/app/errors-tab/): The Errors tab provides a comprehensive view of endpoints with 4xx and 5xx errors across your entire project... - [global-insights](https://learning.postman.com/docs/insights/reference/app/global-insights/): The Global insights page provides a cross-workspace look at all the endpoints captured by the Postman Insights Agent across your organization. - [Explore your endpoint latency](https://learning.postman.com/docs/insights/reference/app/latency-tab/): The Postman Insights Latency tab fetches latency metrics for the API endpoints that the Postman Insights Agent has observed for your service. - [overview-tab](https://learning.postman.com/docs/insights/reference/app/overview-tab/): To give you a quick summary of system health, the Overview tab provides an overview of your service over the last 7 days. - [overview](https://learning.postman.com/docs/insights/reference/app/overview/): Explore the different options, graphs, and settings in the Postman Insights app. - [Fields to redact](https://learning.postman.com/docs/insights/reference/app/settings-tab/): In the Settings tab, you can activate Repro Mode, control what data gets redacted in Repro Mode... - [overview](https://learning.postman.com/docs/insights/reference/overview/): Learn about different Postman Insights features and functions. Explore parts of the Postman Insights app to get your endpoint data and visualizations. ### troubleshoot - [OutofMemory message](https://learning.postman.com/docs/insights/troubleshoot/memory/): The Postman Insights Agent needs at least 300 MB of memory to run. If you've used most memory available, you need to make adjustments. - [overview](https://learning.postman.com/docs/insights/troubleshoot/overview/): Postman Insights shows you the properties of your system based on real-time API traffic. For Insights to work, the Insights Agent needs to see your API traffic. - [Insights project permissions](https://learning.postman.com/docs/insights/troubleshoot/traffic/): Set up the Postman Insights Agent, and you've been running API traffic across the network... - [CLI](https://learning.postman.com/docs/insights/uninstall/): If you need to remove the Postman Insights Agent from your local machine and deployment... ## integrations ### available integrations #### apigee api management - [Create a service account and private key](https://learning.postman.com/docs/integrations/available-integrations/apigee-api-management/deploying-an-api-apigee/): Apigee X enables developers to manage access to their APIs by abstracting services behind a secure proxy layer. - [Prerequisites](https://learning.postman.com/docs/integrations/available-integrations/apimatic/): Postman's APIMatic integration converts a Postman Collection into an API description format such as Swagger, RAML, or API Blueprint... #### aws api gateway - [Connect to Amazon API Gateway](https://learning.postman.com/docs/integrations/available-integrations/aws-api-gateway/deploying-an-api-aws/): Amazon API Gateway enables developers to publish and manage APIs that access AWS and other web services and data sources. - [Upload API schemas to AWS API Gateway](https://learning.postman.com/docs/integrations/available-integrations/aws-api-gateway/): You can connect to Amazon API Gateway from the Postman API Builder. #### azure api management - [Connect to Azure API Management](https://learning.postman.com/docs/integrations/available-integrations/azure-api-management/deploying-an-api-azure/): Azure API Management enables developers to deploy API gateways for APIs hosted in Microsoft Azure, other cloud platforms, or on-premises. - [API sync with Azure DevOps](https://learning.postman.com/docs/integrations/available-integrations/azure-devops/): Azure DevOps Server (hosted on-premises) integrations are available with Postman Enterprise plans with the API Builder add-on. - [Get your BigPanda API key](https://learning.postman.com/docs/integrations/available-integrations/bigpanda/): BigPanda is an IT systems management platform that aggregates and correlates IT alerts to create high-level IT incidents. - [API sync with Bitbucket](https://learning.postman.com/docs/integrations/available-integrations/bitbucket/): Back up your Postman Collections to your Bitbucket repository. #### ci integrations - [Create a pipeline in Azure DevOps](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/azure-pipelines/): The Azure Pipelines integration isn't available on Azure DevOps Server (hosted on-premises). - [Creating a pipeline in Bitbucket](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/bitbucket-pipelines/): Bitbucket Pipelines is a continuous integration and continuous delivery (CI/CD) service that's integrated with Bitbucket Cloud. - [Creating a CircleCI API token](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/circleci/): CircleCI is a cloud-based continuous integration and continuous delivery (CI/CD) platform. - [Create a pipeline in GitHub](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/github-actions/): GitHub Actions self-hosted runners are available with Postman Enterprise plans with the API Builder add-on. - [Create a pipeline in GitLab](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/gitlab-ci/): GitLab Self-managed integrations are available with Postman Enterprise plans with the API Builder add-on. - [Create a Jenkins API token](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/jenkins/): Jenkins is an open source automation server that can act as a continuous integration (CI) server or a continuous delivery (CD) hub. - [Copying your Travis CI API Token](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/travis-ci/): Travis CI is continuous integration (CI) platform that software development teams use to automatically build and test code changes. - [Retrieve your Coralogix private key](https://learning.postman.com/docs/integrations/available-integrations/coralogix/): Coralogix is a machine-learning-powered log analytics platform which improves the delivery and maintenance process for software providers. - [Get your Datadog API key](https://learning.postman.com/docs/integrations/available-integrations/datadog/): Datadog is a monitoring service for cloud-scale applications. - [Configuring Dropbox integration](https://learning.postman.com/docs/integrations/available-integrations/dropbox/): Back up and synchronize your Postman Collections on Dropbox for file sharing, storage, and collaboration. #### github - [Generate a GitHub personal access token](https://learning.postman.com/docs/integrations/available-integrations/github/back-up-collection/): GitHub Enterprise Server integrations are available with Postman Enterprise plans with the API Builder add-on. ##### collections - [Fork a collection connected to your GitHub repository and branch](https://learning.postman.com/docs/integrations/available-integrations/github/collections/collaborate/): Once you connect your GitHub repository and primary branch to your collection, you can fork your collection and collaborate with your team on it. - [Connect a GitHub repository and branch to your collection](https://learning.postman.com/docs/integrations/available-integrations/github/collections/connect/): Connect a GitHub repository and branch to your collection and collaborate with your team on your collection's releases. - [Connect a GitHub repository and branch to your collection](https://learning.postman.com/docs/integrations/available-integrations/github/collections/overview/): Integrate GitHub with Postman Collections and use your GitHub and Postman workflows to collaborate on your collections. - [Collaborate on your collections](https://learning.postman.com/docs/integrations/available-integrations/github/overview/): Integrate GitHub with Postman and use your GitHub and Postman workflows to collaborate with your team on your collections. - [Generate a GitLab personal access token](https://learning.postman.com/docs/integrations/available-integrations/gitlab/): GitLab Self-Managed integrations are available with Postman Enterprise plans with the API Builder add-on. #### jira - [Connect your Jira account to your Postman account](https://learning.postman.com/docs/integrations/available-integrations/jira/connect/): Connect your Jira Cloud account to your Postman account to create your next Jira issue from any HTTP response in Postman. - [Create a Jira issue from an API response](https://learning.postman.com/docs/integrations/available-integrations/jira/create-issue/): Once you connect your Jira account to your Postman account, you can create a new Jira issue from any HTTP response in Postman. - [Connect your Jira account](https://learning.postman.com/docs/integrations/available-integrations/jira/overview/): Connect your Jira Cloud account to Postman and streamline your Jira and Postman workflows. - [View your request's Jira issues](https://learning.postman.com/docs/integrations/available-integrations/jira/view-issues/): View all open Jira issues linked to your requests and collections to track your project's status or assess your API's performance. - [Retrieve your Keen project ID and API Key](https://learning.postman.com/docs/integrations/available-integrations/keen/): Use Keen for API-based computation, Amazon S3 backups, and building visualizations and dashboards for your APIs. - [Get the Microsoft Power Automate webhook URL](https://learning.postman.com/docs/integrations/available-integrations/microsoft-power-automate/): Microsoft Power Automate enables you to automate workflows between your favorite apps and services to get notifications, synchronize files, collect data... - [Get the Postman app for Teams](https://learning.postman.com/docs/integrations/available-integrations/microsoft-teams/): Connect your Postman account to Microsoft Teams with the Postman app. Install the Postman app in Teams to get started. - [Retrieve your New Relic Ingest License key](https://learning.postman.com/docs/integrations/available-integrations/new-relic/): New Relic is an application performance management solution to monitor real-time and trending data for your processes or web apps. - [Get the Opsgenie API key](https://learning.postman.com/docs/integrations/available-integrations/opsgenie/): Opsgenie is an incident management and alerting tool that enables you to manage alerts. - [Retrieving your PagerDuty integration key](https://learning.postman.com/docs/integrations/available-integrations/pagerduty/): PagerDuty is an incident management solution that integrates with monitoring stacks for alerting, on-call scheduling... - [Backup and source control](https://learning.postman.com/docs/integrations/available-integrations/postman-integrations/): With Postman integrations, you can connect Postman to the tools you use in your API development workflow. #### slack - [personal-notifications](https://learning.postman.com/docs/integrations/available-integrations/slack/personal-notifications/): The following table lists the personal notification types available in Slack and provides an example for each type of notification. - [slack-activity](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-activity/): Your team's activity feed keeps you up to date on what your team is working on. - [Install the Postman app for Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-app/): Get the Postman app for Slack to connect your Postman account to Slack. Go to the Postman App for Slack in the Slack App Directory to get started. - [Configure monitors to send results to Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-monitoring/): Postman Monitors enable you to continuously check the health and performance of your APIs. - [Set up notifications in Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-notifications/): Notifications keep you up to date on what's happening in Postman. - [Get the Postman app for Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/): Get the Postman app for Slack to connect your Postman account to Slack. Go to the Postman App for Slack in the Slack App Directory to get started. - [Get the Splunk On-Call API key](https://learning.postman.com/docs/integrations/available-integrations/splunk-on-call/): Splunk On-Call (formerly VictorOps) is a real-time incident management platform that handles incidents as they occur and prepares for the next one. - [Retrieving your Splunk HEC token](https://learning.postman.com/docs/integrations/available-integrations/splunk/): Splunk is a monitoring service for cloud-scale applications. - [Retrieving your Statuspage API key](https://learning.postman.com/docs/integrations/available-integrations/statuspage/): Atlassian's Statuspage is an uptime and incident communication tool. #### teams - [Create a Microsoft Teams webhook URL](https://learning.postman.com/docs/integrations/available-integrations/teams/team-notifications/): Set up Postman Monitors and use a Microsoft Teams webhook URL to connect your monitors to your Teams channels. - [Add the Postman app to Teams](https://learning.postman.com/docs/integrations/available-integrations/teams/teams-app/): Connect your Postman account to Microsoft Teams with the Postman app. Install the Postman app in Teams to get started. - [working-with-openAPI](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/): Import your existing OpenAPI 3.0 and 3.1 definitions (OpenAPI Specification) into Postman. Postman supports both YAML and JSON formats. - [Configure CI integration](https://learning.postman.com/docs/integrations/ci-integrations/): Continuous integration and continuous delivery (CI/CD) are a core part of the API development workflow. - [Add an installed app](https://learning.postman.com/docs/integrations/installed-apps/): Each time you add a new integration, you need to authenticate with the third-party app or service you want to connect to Postman. - [Add integrations](https://learning.postman.com/docs/integrations/intro-integrations/): Connect Postman to your API workflows with integrations for popular third-party solutions. - [Enable static IP support](https://learning.postman.com/docs/integrations/webhooks/): Postman's custom webhook integration enables you to automate workflows between your favorite apps and services to get notifications, synchronize files... ## introduction - [feedback](https://learning.postman.com/docs/introduction/feedback/): Share your thoughts on the Postman Docs and help the Postman team continue improving it for the Postman community. - [Get started](https://learning.postman.com/docs/introduction/overview/): Welcome to the Postman Docs! This is the place to find official information on how to use Postman in your API projects. - [Training collections](https://learning.postman.com/docs/introduction/resources/): If you want to learn more about APIs and Postman, you can access a variety of educational tools from Postman. - [Locating Postman logs](https://learning.postman.com/docs/introduction/troubleshooting-inapp/): If you're having trouble with the Postman app, this guide covers some resources that can help you diagnose and fix the problem. ## monitoring your api - [Monitor settings](https://learning.postman.com/docs/monitoring-your-api/faqs-monitors/): Following are frequently asked questions about configuring, running, updating, securing, and troubleshooting Postman Monitors. - [About Postman Monitors](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/): Postman Monitors enable you to continuously check the health and performance of your APIs. You can create monitors that run requests in selected collections. - [View monitor usage](https://learning.postman.com/docs/monitoring-your-api/monitor-usage/): Postman provides tools to help you manage your team's monitor usage. - [Create a monitor](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/): Create a new monitor to continuously check your API's health, run test suites, or validate critical workflows. - [View failed monitors](https://learning.postman.com/docs/monitoring-your-api/troubleshooting-monitors/): If you encounter a problem with a monitor, the following troubleshooting steps may help you identify and resolve the issue. - [Static IP address monitoring for US Professional and Enterprise plans](https://learning.postman.com/docs/monitoring-your-api/using-static-IPs-to-monitor/): Static IP address monitoring is available with Postman Professional and Enterprise plans. - [Monitor summary](https://learning.postman.com/docs/monitoring-your-api/viewing-monitor-results/): Monitors continuously track the health and performance of your APIs. ## postman ai developer tools ### ai request blocks - [Create a new flow module](https://learning.postman.com/docs/postman-ai-developer-tools/ai-request-blocks/create/): Use AI Request blocks to interact with AI models, which can help you evaluate different models, add AI to your workflows, prototype AI agents... - [Interact with the AI model](https://learning.postman.com/docs/postman-ai-developer-tools/ai-request-blocks/interact/): When you create an AI request block, you select an AI request for it. - [Create your AI request blocks](https://learning.postman.com/docs/postman-ai-developer-tools/ai-request-blocks/overview/): Create AI request blocks to interact with an AI model of your choice, such as one from OpenAI, Google, or Anthropic. ### ai requests - [Add the MCP server](https://learning.postman.com/docs/postman-ai-developer-tools/ai-requests/add-mcp-servers/): Add Model Context Protocol (MCP) servers to your AI requests to give the AI models you interact with further context. - [Create a new AI request](https://learning.postman.com/docs/postman-ai-developer-tools/ai-requests/create/): Create AI requests to interact with AI models. You can use these requests to experiment, test, and evaluate different AI models, such as one from OpenAI... - [Interact with the AI model](https://learning.postman.com/docs/postman-ai-developer-tools/ai-requests/interact/): Interact with AI models with two kinds of prompts: user prompts and system prompts. - [Edit your request authorization details](https://learning.postman.com/docs/postman-ai-developer-tools/ai-requests/manage/): Edit your AI request authorization details and adjust the settings that influence how you interact with the model. - [Create your AI requests](https://learning.postman.com/docs/postman-ai-developer-tools/ai-requests/overview/): Create AI requests to interact with an AI model of your choice, such as one from OpenAI, Anthropic, or Google. ### mcp requests - [Create a new MCP request](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-requests/create/): Create Model Context Protocol (MCP) requests to interact with MCP servers. - [Add the MCP server to Postman Agent Mode](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-requests/export-mcp-server-config/): Add an MCP server to Postman Agent Mode to give it further context and extend its capabilities. - [Interact with an MCP server capability](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-requests/interact/): Interact with Model Context Protocol (MCP) servers with server and client capabilities. - [Edit your STDIO request authorization details](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-requests/manage/): Edit your Model Context Protocol (MCP) request authorization details and adjust the settings that influence how you interact with the server. - [Create your MCP requests](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-requests/overview/): Create Model Context Protocol (MCP) requests to interact with an MCP server of your choice, such as one from the community or one you built yourself. ### mcp server flows - [Create an action and a toolDefinition scenario](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-server-flows/create-mcp-server-flow/): In Postman Flows, you can define a special scenario to create an Action that functions as a Model Context Protocol (MCP) server with MCP tools, prompts... - [Test your MCP server in Postman](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-server-flows/mcp-server-flows/): In Postman Flows, you can define a special scenario to create an Action that functions as a Model Context Protocol (MCP) server with MCP tools, prompts... - [overview](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-server-flows/overview/): Create Model Context Protocol (MCP) servers and MCP tools, prompts, and resources using actions in Postman Flows. ### mcp servers - [Generate and download an MCP server](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-servers/generate/): With Postman's MCP Generator, you choose public API requests from the Postman API Network, and Postman generates a Model Context Protocol (MCP) server for you. - [Interact with your MCP server and an AI model](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-servers/interact/): Use Postman to interact with your generated MCP server locally and an AI model of your choice. - [Generate MCP servers](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-servers/overview/): With Postman's MCP Generator, you can create a Model Context Protocol (MCP) server with public APIs from the Postman API Network. - [Become a publisher](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-servers/promote/): The Postman API Network is where millions of developers discover, test, and integrate APIs. - [Set up your MCP server](https://learning.postman.com/docs/postman-ai-developer-tools/mcp-servers/set-up-start/): For each request you add to your Model Context Protocol (MCP) server, Postman generates a tool for you. - [Send requests to AI models](https://learning.postman.com/docs/postman-ai-developer-tools/overview/): With Postman, you can experiment, test, and evaluate AI models and Model Context Protocol (MCP) servers. ## postman api network ### explore - [Choose public elements](https://learning.postman.com/docs/postman-api-network/explore/consume/): Before you consume a public API, learn how to choose one from a verified team. A public API from a verified team offers you the best developer experience. #### find - [Explore](https://learning.postman.com/docs/postman-api-network/explore/find/browse/): Browse public workspaces, collections, requests, APIs, flows, and teams on a variety of pages curated by Postman... - [Search for public APIs](https://learning.postman.com/docs/postman-api-network/explore/find/overview/): Search and browse the Postman API Network to discover public workspaces, collections, requests, APIs, flows, and teams. - [Search for Postman elements](https://learning.postman.com/docs/postman-api-network/explore/find/search/): Search for any workspace, collection, request, API, flow, or team you have access to. - [Find APIs](https://learning.postman.com/docs/postman-api-network/explore/overview/): The Postman API Network is the world's largest network of public APIs. ### showcase - [Key metrics and insights](https://learning.postman.com/docs/postman-api-network/showcase/analyze-developer-engagement/): Publisher analytics gives you a full view into how developers engage with your public Postman collections, forked collections, workspace updates... - [View and manage your team's public profile](https://learning.postman.com/docs/postman-api-network/showcase/explore-publisher-tools/): Access your public profile, workspaces, analytics, and team settings from the Postman API Network's landing page. - [Prepare your public APIs](https://learning.postman.com/docs/postman-api-network/showcase/overview/): Introduce your public APIs to over 40 million users from around the globe. #### prepare ##### curate - [Curate your public collection's overview](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/overview/): Curate your public collections for the Postman API Network and get your API consumers to their first 200 OK response in the fewest steps as possible. - [Set up authentication and authorization for your collection](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/public-collections-developer-experience/): Curate your public collection's developer experience for your API consumers by setting up authentication and authorization, variables and environments... - [Name your collection](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/public-collections-overview/): Curate your collection's overview to introduce your public APIs to your API consumers. - [Add requests to your collection](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/public-collections-requests/): Curate your collection's requests to communicate your public API's capabilities to your API consumers. - [Prepare and verify your publisher team](https://learning.postman.com/docs/postman-api-network/showcase/prepare/overview/): Get started on your API publisher journey by preparing and curating your publisher team, workspaces, and collections for the Postman API Network. - [Create your public API reference collection](https://learning.postman.com/docs/postman-api-network/showcase/prepare/public-collections/): Create a public API reference collection and overview collection for your API consumers. - [Create your public workspace](https://learning.postman.com/docs/postman-api-network/showcase/prepare/public-workspace/): Your public workspace is a landing page for your public APIs. - [Create your private or team workspace](https://learning.postman.com/docs/postman-api-network/showcase/prepare/team-workspace/): Use a team workspace to draft and organize your work, and collaborate with your team. - [Get started with your application](https://learning.postman.com/docs/postman-api-network/showcase/prepare/verify-publisher-team/): Get verified by Postman and increase the number of API consumers who use your public APIs. When you verify your profile, you earn a verification badge. #### publish - [Update your public collections with a pull request](https://learning.postman.com/docs/postman-api-network/showcase/publish/maintain-public-apis/): If you prepared a team workspace for team collaboration, you can draft your next release there. ##### notebooks - [Create a notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/create/): Create an interactive article to guide your API consumers to their first 200 OK response. ###### draft - [Add a code runner block](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/add-code-runner-blocks/): Add JavaScript code snippets and reference their output elsewhere in your notebook to create an interactive experience. - [Add an input block](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/add-input-blocks/): Add variables and reference them elsewhere in your notebook to create an interactive experience. - [Add a request block](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/add-request-blocks/): Add API requests and reference their responses elsewhere in your notebook to create an interactive experience. - [Format text](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/format/): Format your notebook with text and block styles. Use text styles to bold, italicize, underline, and strike through text. - [Format content](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/overview/): Draft your notebook and engage your API consumers. Walk them through a real-world use case and guide them to their first 200 OK response, all in one place. - [Create a notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/overview/): With Postman Notebooks, you showcase your public APIs with interactive articles. - [Publish your notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/publish/): Publish your notebook and share your interactive documentation, code, and APIs with your API consumers. - [Publish your public APIs](https://learning.postman.com/docs/postman-api-network/showcase/publish/overview/): Publish your APIs to the Postman API Network and make them publicly available to any API consumer around the world. - [Evaluate the developer experience](https://learning.postman.com/docs/postman-api-network/showcase/publish/public-apis/): Once you've prepared your public workspace, prepared your public collections, curated them, and prepared your team workspace for team collaboration... ## postman cli - [macOS, Linux, and Windows Subsystem for Linux (WSL) installation](https://learning.postman.com/docs/postman-cli/postman-cli-installation/): Install the Postman CLI by following the instructions for your operating system below. - [Basic command line options](https://learning.postman.com/docs/postman-cli/postman-cli-options/): This topic covers the commands and options supported by the Postman CLI. Basic command line options postman The base command of the Postman CLI is postman. - [Comparing the Postman CLI and Newman](https://learning.postman.com/docs/postman-cli/postman-cli-overview/): The Postman CLI is a secure command-line companion for Postman. It's signed and supported by Postman, like the Postman app. - [About built-in reporters](https://learning.postman.com/docs/postman-cli/postman-cli-reporters/): The Postman CLI has built-in reporters you can use to generate reports for your collection runs. - [Run a collection locally with the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-collection/): Use the Postman CLI to manually run collections to test the functionality of your API. - [Configure a monitor for your CI/CD pipeline](https://learning.postman.com/docs/postman-cli/postman-cli-run-monitor/): Use the Postman CLI to run monitors to test the functionality of your API. You can also use the Postman CLI to automate monitors in your CI/CD pipelines. ## postman flows ### ai - [Use Postbot to help build your flow](https://learning.postman.com/docs/postman-flows/ai/postbot/): Postman's AI assistant Postbot can help build and debug your flows. ### build flows - [Obtain the request body](https://learning.postman.com/docs/postman-flows/build-flows/actions-form-data/): In a Postman Flows action, the Request block gets input data from a scenario. That enables you to test the action locally. - [Create an action](https://learning.postman.com/docs/postman-flows/build-flows/actions/): An action is a flow that's deployed in the Postman cloud. - [analytics](https://learning.postman.com/docs/postman-flows/build-flows/analytics/): The Analytics tab in Postman Flows provides details about how your deployed actions run in the Postman Cloud. - [Clone a flow into the same workspace](https://learning.postman.com/docs/postman-flows/build-flows/clone-flows/): Create copies of flows with the clone feature in Postman Flows. - [Identify values your action will need](https://learning.postman.com/docs/postman-flows/build-flows/configure-values-actions/): When you create an action, you'll often want to include static values for its blocks to use. - [Copy and paste blocks](https://learning.postman.com/docs/postman-flows/build-flows/create-blocks/): All blocks have an input port, an output port, or both. Input ports are on the left side of a block, and output ports are on the right. - [create-connections](https://learning.postman.com/docs/postman-flows/build-flows/create-connections/): Blocks communicate with each other through connections. Connections are like unidirectional conduits that carry data between blocks. - [date-and-time](https://learning.postman.com/docs/postman-flows/build-flows/date-and-time/): Many APIs expect different formats for date and time. - [Contains](https://learning.postman.com/docs/postman-flows/build-flows/find-and-filter-data/): Frequently, the need arises to check if information in a flow has a certain value. #### loops - [What's inside a loop in flows](https://learning.postman.com/docs/postman-flows/build-flows/loops/loops-external-data/): The Loops Overview showed how to build loops that begin with a For or Repeat block... - [Build a loop for pagination](https://learning.postman.com/docs/postman-flows/build-flows/loops/loops-pagination/): Use Postman Flows to build a "while do" loop that's well-suited to pagination use cases. - [Build a loop for polling](https://learning.postman.com/docs/postman-flows/build-flows/loops/loops-polling/): Use Postman Flows to build a "while do" loop that polls an API for new values until a condition is satisfied. - [Loops with the Repeat block](https://learning.postman.com/docs/postman-flows/build-flows/loops/overview/): Loops are a basic element of control flow in computer programming that Postman Flows supports. - [Colors](https://learning.postman.com/docs/postman-flows/build-flows/organize-flows/): As you build more flows and their designs become more complex, the ability to organize your flows becomes more important. - [Build your first flow](https://learning.postman.com/docs/postman-flows/build-flows/overview/): Postman Flows lets you automate and visualize API workflows using modular building blocks. - [Requests](https://learning.postman.com/docs/postman-flows/build-flows/requests-and-variables/): Send API requests and receive responses in your flows with the HTTP Request block. - [Start block inputs](https://learning.postman.com/docs/postman-flows/build-flows/scenarios/): Scenarios are sets of values assigned to Start block inputs. - [Share a flow with a link](https://learning.postman.com/docs/postman-flows/build-flows/share-and-embed-flows/): Share flows by sending links or embedding iframes in websites and other online resources. - [Create slides](https://learning.postman.com/docs/postman-flows/build-flows/slides/): Create on-canvas demos and tutorials for your flows with slides. - [Create a snapshot](https://learning.postman.com/docs/postman-flows/build-flows/snapshots/): Snapshots enable you to save, view, and restore versions of your flows. - [Preview inputs, outputs, and details](https://learning.postman.com/docs/postman-flows/build-flows/troubleshoot/): Whether you're developing an application with code or building a flow with Postman Flows, sometimes things don't work as expected. - [Visualization types](https://learning.postman.com/docs/postman-flows/build-flows/visualize-data/): The Display block accepts information from other blocks and creates a visualization of that information. You can select from several visualization types. ### cookbook - [Recipe](https://learning.postman.com/docs/postman-flows/cookbook/ai-agent-as-logic/): The traditional method of performing logic in a flow uses a series of blocks. - [Recipe](https://learning.postman.com/docs/postman-flows/cookbook/iterate-list-for-block/): A common Flows design pattern involves getting a response from a request that returns a list, then processing each item in the list. - [overview](https://learning.postman.com/docs/postman-flows/cookbook/overview/): The Postman Flows Cookbook is a collection of practical recipes for developing flows. Each recipe describes the best practice for a specific real-world example. - [Recipe](https://learning.postman.com/docs/postman-flows/cookbook/persist-data-outside-flow/): Data in flows is transient by default. Whatever data the flow retrieves or processes is cleared or replaced when the flow runs again. - [Recipe](https://learning.postman.com/docs/postman-flows/cookbook/select-data-from-complex-json/): Selecting and processing data from responses is a fundamental function in Postman Flows. - [Recipe](https://learning.postman.com/docs/postman-flows/cookbook/use-typescript-in-evaluate/): Use TypeScript to process and manipulate data in Evaluate, Condition, and If blocks in your flows. ### flows query language - [Example JSON](https://learning.postman.com/docs/postman-flows/flows-query-language/conditional-data-selection/): Use Flows Query Language (FQL) to filter for specific data in your responses. Multiple responses return in an array. Single responses return as a single record. - [Working with strings](https://learning.postman.com/docs/postman-flows/flows-query-language/data-manipulation/): Use Flows Query Language (FQL) to perform math functions, manipulate strings and arrays, and interact with the data in your responses. - [Logical Operators](https://learning.postman.com/docs/postman-flows/flows-query-language/function-reference/): All Flows Query Language (FQL) functions are documented below. Logical Operators and Returns true if all provided conditions are true. - [Example JSON](https://learning.postman.com/docs/postman-flows/flows-query-language/get-basic-values/): FQL uses location path syntax to extract values from JSON structures. The following examples show several examples of getting basic values from JSON data. - [FQL compared to TypeScript](https://learning.postman.com/docs/postman-flows/flows-query-language/introduction-to-fql/): Use Flows Query Language (FQL) to parse and transform JSON data to get the fields and structure you want. - [Return multiple objects as an array](https://learning.postman.com/docs/postman-flows/flows-query-language/return-structured-results/): The following examples show how to use FQL to return structured data from JSON data. ### get started - [Create a new flow module](https://learning.postman.com/docs/postman-flows/get-started/build-your-first-flow/): Postman Flows is a visual, low-code editor you can use to build almost any workflow you can imagine. - [Explore Flows template gallery](https://learning.postman.com/docs/postman-flows/get-started/flows-catalog/): Flows Template Gallery is a collection of over 100 pre-built flow modules designed to address common use cases. - [The Postman Flows user interface](https://learning.postman.com/docs/postman-flows/get-started/flows-interface/): Postman Flows has a visual interface that supports building API-driven applications without writing code. - [Use the Postman Flows editor and canvas to build your Flows](https://learning.postman.com/docs/postman-flows/get-started/overview/): With Postman Flows, you can collaborate with your team and build API-first apps that automate tasks, integrate systems... - [Get started with Flows](https://learning.postman.com/docs/postman-flows/overview/): Use the Postman Flows low-code editor to prototype, build, and deploy API-first apps in a collaborative environment. ### reference #### blocks - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/ai-agent/): The AI Agent block is an AI assistant that can automate tasks in Postman Flows. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/ai-request/): The AI Request block runs an AI request from your collection and sends the result from one of its output ports. - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/bool/): The Bool block sends a true or false value from its output port. This can be useful when you want to control your flow based on a condition. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/collect/): The Collect block receives individual data items from iterations of a loop, then aggregates them into a list, formatted as a JSON array like this: "item1"... - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/condition/): The Condition block is a logical gate that routes data through one of multiple output ports based on the results of one or more conditions. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/create-variable/): The Create Variable block creates a variable and assigns it a name and a value. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/create-with-ai/): The Create with AI block is a beta feature. The Create with AI block uses artificial intelligence (AI) models to generate text, images... - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/date-and-time/): The Date & Time block is a data block that sends the specified date and time as the number of milliseconds since the Unix epoch (January 1, 1970). - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/date/): The Date block sends the specified date as the number of milliseconds since the Unix epoch (January 1, 1970). - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/delay/): The Delay block receives data from one or more blocks, then waits for the specified number of milliseconds before sending the data from its output port. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/evaluate/): The Evaluate block is a powerful tool for manipulating and evaluating data. - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/flow-module/): The Flow Module block references a flow module from your workspace and outputs its result. - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/for/): The For block always serves as the beginning of a loop. See Loops with the For block. - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/get-configuration/): The Get Configuration block, available only in Flows actions, retrieves the specified configuration's value and sends that value from its output port. - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/get-variable/): The Get Variable block can retrieve the value of any variable defined by a Create Variable block anywhere in the flow. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/http-request/): The HTTP Request block runs an HTTP request that you select from a collection and sends the result from its output port. - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/if/): The If block is a logical gate that routes data through one of two output ports based on the result of an evaluation. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/list/): The List block sends an array in your flow. You can define the items in the array by inserting data blocks into the List block. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/log/): The Log block accepts information to its input port and sends the information to the Postman Console. The Log block is useful for debugging flows. - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/now/): When the flow runs, the Now block sends the current date and time as the number of milliseconds since the Unix epoch (January 1, 1970). - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/null/): When the flow runs, the Null block sends a null value from its output port. - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/number/): The Number block sends the specified whole or decimal number. The number can be positive or negative. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/output-display/): The Display block shows data from other blocks in one of several formats, including images, text, numbers, and charts. - [Inputs and outputs](https://learning.postman.com/docs/postman-flows/reference/blocks/output-module/): This Output block is different from the previous version of the Output block, which became the Display block. - [Insert data blocks into other blocks](https://learning.postman.com/docs/postman-flows/reference/blocks/overview/): A block is a fundamental unit of a flow. Each block stores information or performs a task. You can configure a block to fit your specific use case. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/record/): The Record block creates key-value pairs from received data and sends them as a JSON object. - [regex](https://learning.postman.com/docs/postman-flows/reference/blocks/regex/): The Regex block is deprecated and isn't available in Postman Flows. - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/repeat/): The Repeat block functions as the starting point for a loop. - [Outputs](https://learning.postman.com/docs/postman-flows/reference/blocks/request/): The Request block is a special block that's present by default in Flows actions. - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/response/): The Response block is a special block that can only be added to actions. - [Outputs](https://learning.postman.com/docs/postman-flows/reference/blocks/schedule/): The Schedule block is a special block in actions that lets you specify when and how often an action will automatically run. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/select/): The Select block receives JSON data from another block and extracts an element that you specify. - [Inputs](https://learning.postman.com/docs/postman-flows/reference/blocks/start/): The Start block is automatically added to every new flow module. You can add inputs that receive data from scenarios. - [Output](https://learning.postman.com/docs/postman-flows/reference/blocks/string/): The String block outputs a sequence of characters that's configured in the block. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/template/): The Template block enables you to insert variable values into a predefined text document and pass the value on to another block. - [Input](https://learning.postman.com/docs/postman-flows/reference/blocks/validate/): The Validate block is a logical gate that checks incoming JSON data against a schema and routes the data based on the result. - [Manage long-running actions](https://learning.postman.com/docs/postman-flows/reference/flows-actions-overview/): An action is a flow that's deployed in the Postman cloud. - [overview-action-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-action-blocks/): Action blocks include the following: HTTP Request Flow Module - [overview-ai-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-ai-blocks/): AI blocks include the following: AI Agent Create with AI AI Request - [overview-data-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-data-blocks/): Data blocks include the following: String Bool Number Null Select Now Date Date & Time List Record Create... - [overview-logic-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-logic-blocks/): Logic blocks include the following: Condition Validate If Evaluate Delay - [overview-looping-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-looping-blocks/): Looping blocks include the following: Repeat For Collect - [overview-trigger-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-trigger-blocks/): Trigger blocks include the following: Output Request Response Schedule Start - [overview-visualize-blocks](https://learning.postman.com/docs/postman-flows/reference/overview-visualize-blocks/): Visualize blocks include the following: Display Log - [Blocks reference](https://learning.postman.com/docs/postman-flows/reference/overview/): The Flows reference section provides descriptions, details, and examples for blocks, TypeScript functions, and Flows Query Language (FQL). ### tutorials #### advanced - [Prerequisites](https://learning.postman.com/docs/postman-flows/tutorials/advanced/automate-repetitive-tasks/): Use Postman Flows to complete repetitive tasks. Businesses often need to delete emails from multiple systems. - [Goal](https://learning.postman.com/docs/postman-flows/tutorials/advanced/create-a-dashboard-in-flows/): Dashboards are useful for visualizing and simplifying large amounts of data. - [overview](https://learning.postman.com/docs/postman-flows/tutorials/advanced/overview/): Continue your Postman Flows journey with these advanced tutorials. - [Run multiple requests in sequence](https://learning.postman.com/docs/postman-flows/tutorials/advanced/run-requests-in-sequence/): When you have several requests with no dependency on each other and you want them sent in a specific order... - [Goal](https://learning.postman.com/docs/postman-flows/tutorials/advanced/send-information-from-one-system-to-another/): Developers often integrate multiple APIs to leverage their individual features. #### beginner - [Create a new flow](https://learning.postman.com/docs/postman-flows/tutorials/beginner/calculate-years-since-milestone/): Build a flow to calculate the years since an important date, such as an anniversary, when one of your customers opened an account... - [Create a new flow](https://learning.postman.com/docs/postman-flows/tutorials/beginner/create-count-based-loop/): Build a flow that loops over a count. For example, you can run a flow that loops over a count of three and generates a list of three random numbers. - [Create a new flow](https://learning.postman.com/docs/postman-flows/tutorials/beginner/create-list-based-loop/): Build a flow that loops over a list. For example, you can run a flow that loops over a list of email addresses and emails each person in the list. - [Build a flow that sends an API request](https://learning.postman.com/docs/postman-flows/tutorials/beginner/overview/): If you're new to Postman Flows, these tutorials will familiarize you with the Flows interface and prepare you to build more complex, API-first workflows. - [Create a new flow](https://learning.postman.com/docs/postman-flows/tutorials/beginner/send-request/): Build a flow that uses a request from your workspace or the Postman API Network. You can also create a new request when building your flow. - [Get started with beginner tutorials](https://learning.postman.com/docs/postman-flows/tutorials/overview/): These tutorials can help you harness the power of Postman Flows, showing you how to automate tasks, integrate systems, and send requests in flow modules. #### video - [create-first-flow](https://learning.postman.com/docs/postman-flows/tutorials/video/create-first-flow/): Discover Postman Flows, a visual canvas where you can build, test, and share API-powered applications with a user-friendly drag-and-drop interface. - [create-with-ai](https://learning.postman.com/docs/postman-flows/tutorials/video/create-with-ai/): Explore the AI capabilities in Postman Flows and how you can seamlessly integrate AI into your workflows. - [overview](https://learning.postman.com/docs/postman-flows/tutorials/video/overview/): Continue your Postman Flows journey with these video tutorials. - [work-with-actions](https://learning.postman.com/docs/postman-flows/tutorials/video/work-with-actions/): Discover how to build and deploy fully functional applications with actions in Postman Flows. - [work-with-scenarios](https://learning.postman.com/docs/postman-flows/tutorials/video/work-with-scenarios/): With scenarios in Postman Flows, you can add multiple sets of inputs to your Start block, which you can then use as parameters for your API. - [work-with-snapshots](https://learning.postman.com/docs/postman-flows/tutorials/video/work-with-snapshots/): Use snapshots to save your flow at different points as it evolves over time. ### typescript - [Example JSON](https://learning.postman.com/docs/postman-flows/typescript/typescript-check-for-session-cookie/): This TypeScript example checks an API response for a sails.sid cookie. If a sails. - [Example JSON](https://learning.postman.com/docs/postman-flows/typescript/typescript-health-performance-routing/): This example uses three TypeScript expressions to route response data based on health and performance using a Condition block. - [TypeScript compared to FQL](https://learning.postman.com/docs/postman-flows/typescript/typescript-overview/): Use TypeScript to enhance logic and functionality in the logic blocks of your Postman Flows. - [Example JSON](https://learning.postman.com/docs/postman-flows/typescript/typescript-rename-headers/): This TypeScript example renames the Content-Type and Content-Length headers using camel case. ## publishing your api - [Document collections and APIs](https://learning.postman.com/docs/publishing-your-api/api-documentation-overview/): Documentation is an important part of your API. You can add documentation to any Postman Collection and its API requests. - [Adding descriptions to your documentation](https://learning.postman.com/docs/publishing-your-api/authoring-your-documentation/): Postman automatically generates documentation for every collection you create, including collections linked to an API. - [Add a custom domain](https://learning.postman.com/docs/publishing-your-api/custom-doc-domains/): Custom documentation domains are available with Postman paid plans. - [Add descriptions to a collection](https://learning.postman.com/docs/publishing-your-api/document-a-collection/): Postman automatically generates basic documentation for any collection you create. - [Add API documentation with collections](https://learning.postman.com/docs/publishing-your-api/documenting-your-api/): View, create, and manage your API's documentation either with collections or the Postman API Builder. - [Make your documentation public](https://learning.postman.com/docs/publishing-your-api/publishing-your-docs/): Publishing your documentation makes it publicly available to anyone with the link to the documentation. ### run in postman - [Create a Run in Postman button](https://learning.postman.com/docs/publishing-your-api/run-in-postman/creating-run-button/): Create a Run in Postman button to instantly bring your Postman collections into your user's environment. - [Pass a user's sign-in credentials](https://learning.postman.com/docs/publishing-your-api/run-in-postman/customize-run-button/): As an API publisher, you can dynamically inject information as environment variables into the Run in Postman button. - [Create a Run in Postman button](https://learning.postman.com/docs/publishing-your-api/run-in-postman/introduction-run-button/): Once you've prepared your public collections, curated them, and published your public APIs, create a Run in Postman button. - [API authentication setup](https://learning.postman.com/docs/publishing-your-api/setting-up-authentication-for-public-apis/): Efficiently onboard your API consumers by setting up Guided Auth for your public APIs in Postman. - [Viewing documentation for a collection](https://learning.postman.com/docs/publishing-your-api/viewing-documentation/): Documentation helps you get more out of the collections and APIs that you work with in Postman. ## reports - [API Builder](https://learning.postman.com/docs/reports/api-builder-reports/): API Builder reports are available with Postman Enterprise plans. - [Access the report dashboard](https://learning.postman.com/docs/reports/api-governance-specifications-reports/): Governance reports are available with Postman Enterprise plans. - [API Security](https://learning.postman.com/docs/reports/api-security-reports/): The API Security report dashboard provides metrics relevant to the API Security posture of your Postman APIs. - [billing-overview-reports](https://learning.postman.com/docs/reports/billing-overview-reports/): Reports are available with all Postman Enterprise plans. - [Workspaces overview](https://learning.postman.com/docs/reports/content-activity-reports/): Reports are available with all Postman Enterprise plans. - [internal-workspaces-reports](https://learning.postman.com/docs/reports/internal-workspaces-reports/): Reports are available with all Postman Enterprise plans. - [members-overview-reports](https://learning.postman.com/docs/reports/members-overview-reports/): Reports are available with all Postman Enterprise plans. - [overview-reports](https://learning.postman.com/docs/reports/overview-reports/): Reports are available with all Postman Enterprise plans. The Overview report gives you a snapshot of high-level information about your team and plan. - [Getting started with reports](https://learning.postman.com/docs/reports/reports-overview/): Reports are available with all Postman Enterprise plans. The Public workspace metrics report is available with all Postman plans. - [secret-scanner-reports](https://learning.postman.com/docs/reports/secret-scanner-reports/): Secret Scanner reports are available with the Enterprise plan with the Advanced Security Admin add-on. ## sending requests ### authorization - [akamai-edgegrid](https://learning.postman.com/docs/sending-requests/authorization/akamai-edgegrid/): Akamai EdgeGrid is an authorization helper developed and used by Akamai. To use Akamai EdgeGrid, do the following: 1. - [atlassian](https://learning.postman.com/docs/sending-requests/authorization/atlassian/): Atlassian S2S Authentication Protocol (ASAP) is a JSON Web Token (JWT) bearer token that an API server can use to authenticate requests from the client. - [Set up authorization](https://learning.postman.com/docs/sending-requests/authorization/authentication-for-public-apis/): An increasing number of public APIs offer Guided Auth in Postman, including Stripe, Open AI, Notion, and Spotify. - [No auth](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/): Postman supports several types of authorization. Select a type from the Auth Type dropdown list on the Authorization tab of a request. - [Authentication in Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization/): Postman enables you to send auth details with your API requests. APIs use authentication and authorization to ensure that client requests access data securely. - [aws-signature](https://learning.postman.com/docs/sending-requests/authorization/aws-signature/): AWS Signature is the authorization workflow for Amazon Web Services requests. - [Manage certificates](https://learning.postman.com/docs/sending-requests/authorization/certificates/): Add and manage certificates in Postman to enable authentication when sending requests. - [digest-auth](https://learning.postman.com/docs/sending-requests/authorization/digest-auth/): With Digest auth, the client sends a first request to the API, and the server responds back with details. - [hawk-authentication](https://learning.postman.com/docs/sending-requests/authorization/hawk-authentication/): Hawk authentication enables you to authorize requests using partial cryptographic verification. To use Hawk authentication, do the following: 1. - [ntlm-authentication](https://learning.postman.com/docs/sending-requests/authorization/ntlm-authentication/): Windows NTLM is the authorization flow for the Windows operating system and for standalone systems. NTLM is a challenge-response style authentication protocol. - [OAuth 1.0 overview](https://learning.postman.com/docs/sending-requests/authorization/oauth-10/): OAuth 1.0 enables client applications to access data provided by a third-party API. - [OAuth 2.0 overview](https://learning.postman.com/docs/sending-requests/authorization/oauth-20/): With OAuth 2.0, you first retrieve an access token for the API, then use that token to authenticate future requests. - [Select an authorization type](https://learning.postman.com/docs/sending-requests/authorization/specifying-authorization-details/): With a request open in Postman, use the Authorization tab to select an auth type, then complete the relevant details for your selected type. ### capturing request data - [The Postman proxy](https://learning.postman.com/docs/sending-requests/capturing-request-data/capture-overview/): Capturing HTTP traffic is an important tool for API development and testing. - [How the built-in proxy works](https://learning.postman.com/docs/sending-requests/capturing-request-data/capture-with-proxy/): If you're using APIs to build client-side applications like mobile and desktop apps or websites... - [How the built-in proxy works](https://learning.postman.com/docs/sending-requests/capturing-request-data/capturing-http-requests/): Follow these steps if you're on Linux (all Postman versions), macOS (Postman v10.16 or earlier), or Windows (Postman v10.17 or earlier). - [Windows](https://learning.postman.com/docs/sending-requests/capturing-request-data/capturing-https-traffic/): In addition to capturing HTTP traffic, you can use the Postman's built-in proxy to inspect HTTPS communication from your Android, iOS, Linux, macOS... - [Install Interceptor](https://learning.postman.com/docs/sending-requests/capturing-request-data/interceptor/): Postman Interceptor is a browser extension that acts as a companion to Postman. - [Sync cookies with Postman Interceptor](https://learning.postman.com/docs/sending-requests/capturing-request-data/syncing-cookies/): Postman enables you to capture and sync cookies from a web browser or another client application to the Postman cookie jar. ### create requests - [Build API requests in Postman](https://learning.postman.com/docs/sending-requests/create-requests/create-requests/): Use the Postman API client to connect to APIs you're building, testing, or integrating with. - [Generate code snippets in Postman](https://learning.postman.com/docs/sending-requests/create-requests/generate-code-snippets/): Postman can convert an API request into a code snippet. You can then use the generated code snippet in your front-end application to make calls to an API. - [Configure request headers](https://learning.postman.com/docs/sending-requests/create-requests/headers/): Some APIs require you to send particular headers with requests to provide metadata about the operation you're performing. - [intro-to-collections](https://learning.postman.com/docs/sending-requests/create-requests/intro-to-collections/): Postman Collections enable you to group together your API requests and examples. - [Send request parameters](https://learning.postman.com/docs/sending-requests/create-requests/parameters/): The Postman API client enables you to send data along with your HTTP requests. You can add query and path parameters to a request and specify their values. - [Create a new request](https://learning.postman.com/docs/sending-requests/create-requests/request-basics/): Postman supports sending requests using HTTP, GraphQL, gRPC, WebSocket, MQTT, and SOAP protocols. - [Configure custom request settings](https://learning.postman.com/docs/sending-requests/create-requests/request-settings/): Configure a variety of settings for your API requests in Postman. These settings enable you to customize Postman's behavior when sending a request. - [About test data storage](https://learning.postman.com/docs/sending-requests/create-requests/test-data/): Test data storage is available with Postman Free, Basic, and Professional plans. ### graphql - [Create a GraphQL request with one query](https://learning.postman.com/docs/sending-requests/graphql/graphql-client-first-request/): Use Postman's GraphQL client to create GraphQL requests with one or multiple queries. - [The request section](https://learning.postman.com/docs/sending-requests/graphql/graphql-client-interface/): Postman has a special client for GraphQL requests called the GraphQL client. - [Use Postman's HTTP request for GraphQL](https://learning.postman.com/docs/sending-requests/graphql/graphql-http/): Postman's GraphQL client is tailored for making GraphQL requests, but you can also create GraphQL requests using Postman's HTTP request interface. - [About GraphQL](https://learning.postman.com/docs/sending-requests/graphql/graphql-overview/): Postman can make requests using GraphQL, an open-source query language and runtime for APIs. ### grpc - [About gRPC API requests](https://learning.postman.com/docs/sending-requests/grpc/first-grpc-request/): This guide describes how to create and invoke a gRPC request in Postman using the Postman Echo service for gRPC. - [grpc-client-overview](https://learning.postman.com/docs/sending-requests/grpc/grpc-client-overview/): Postman can make requests using gRPC, a schema-driven Remote Procedure Call (RPC) framework often used to enable inter-service communication. - [Creating a new request](https://learning.postman.com/docs/sending-requests/grpc/grpc-request-interface/): Postman's gRPC client interface provides a variety of specialized tools, views, and controls for invoking and testing gRPC requests. - [The pm object](https://learning.postman.com/docs/sending-requests/grpc/postman-sandbox-api/): Postman provides JavaScript APIs with the pm object, enabling you to test and access request and response data in your gRPC scripts run in the Postman Sandbox. - [Next steps](https://learning.postman.com/docs/sending-requests/grpc/scripting-in-grpc-request/): Postman has a powerful scripting environment that enables you to add JavaScript code (scripts) in your gRPC requests. - [Test status code](https://learning.postman.com/docs/sending-requests/grpc/test-examples/): Write tests for your gRPC requests using scripts. Depending on the logic and how you want to get the results... - [JSON interface](https://learning.postman.com/docs/sending-requests/grpc/understanding-grpc-types/): When sending or receiving a gRPC request or response, the messages being sent back and forth are transmitted in a format called protobuf (protocol buffers). - [Saving a gRPC example](https://learning.postman.com/docs/sending-requests/grpc/using-grpc-examples/): Save, edit, and share gRPC request-response pairs as examples. You can even create gRPC examples from scratch. - [Use a gRPC mock server](https://learning.postman.com/docs/sending-requests/grpc/using-grpc-mock/): In an API-first design lifecycle, you may be designing a new feature that depends on new API endpoints... - [Use server reflection](https://learning.postman.com/docs/sending-requests/grpc/using-service-definition/): gRPC is a schema-driven framework. This means the client and server must adhere to a standard agreement (schema) while invoking and running a request. ### mqtt client - [Create an MQTT request](https://learning.postman.com/docs/sending-requests/mqtt-client/first-mqtt-request/): In this example of an MQTT request, you will connect to a public broker, subscribe to topics, publish messages, and visualize the response. - [Work with MQTT APIs using Postman](https://learning.postman.com/docs/sending-requests/mqtt-client/mqtt-client-overview/): MQTT (Message Queuing Telemetry Transport) is a messaging protocol for the Internet of Things (IoT). - [Create a new MQTT request](https://learning.postman.com/docs/sending-requests/mqtt-client/mqtt-request-interface/): MQTT requests in Postman include a variety of tools, views, and controls to help you debug and document your MQTT APIs. ### postman vault - [About the 1Password integration](https://learning.postman.com/docs/sending-requests/postman-vault/1password/): Postman Vault integrations are available with Postman Enterprise plans with the Advanced Security Administration add-on. - [About the AWS Secrets Manager integration](https://learning.postman.com/docs/sending-requests/postman-vault/aws-secrets-manager/): Postman Vault integrations are available with Postman Enterprise plans with the Advanced Security Administration add-on. - [About the Azure Key Vault integration](https://learning.postman.com/docs/sending-requests/postman-vault/azure-key-vault/): Postman Vault integrations are available with Postman Enterprise plans with the Advanced Security Administration add-on. - [About the HashiCorp Vault integration](https://learning.postman.com/docs/sending-requests/postman-vault/hashicorp-vault/): Postman Vault integrations are available with Postman Enterprise plans with the Advanced Security Administration add-on. - [Set expiration duration for cached secrets](https://learning.postman.com/docs/sending-requests/postman-vault/manage-postman-vault-integrations/): Postman Vault integrations are available with Postman Enterprise plans with the Advanced Security Administration add-on. - [Add authorization as vault secrets using Guided Auth](https://learning.postman.com/docs/sending-requests/postman-vault/manage-vault-secrets-using-guided-auth/): Use Guided Auth to add vault secrets to your Postman Vault, enabling you to store authentication credentials for public APIs that set up Guided Auth. - [Add sensitive data as vault secrets](https://learning.postman.com/docs/sending-requests/postman-vault/manage-vault-secrets/): Add vault secrets to your Postman Vault and reuse them in your local instance of Postman. - [About Postman Vault integrations](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-integrations/): Postman Vault integrations are available with Postman Enterprise plans with the Advanced Security Administration add-on. - [Save your vault key](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-key/): Postman generates a vault key when you open your Postman Vault for the first time. - [Access your Postman Vault](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/): Postman Vault enables you to store sensitive data as vault secrets in your local instance of Postman. - [View empty and unresolved vault secrets](https://learning.postman.com/docs/sending-requests/postman-vault/troubleshoot-vault-secrets/): A vault secret, vault secret added using Guided Auth... - [Get started sending requests](https://learning.postman.com/docs/sending-requests/requests/): Send HTTP requests in Postman to test your APIs and explore different request methods. ### response data - [About cookies](https://learning.postman.com/docs/sending-requests/response-data/cookies/): Postman's cookie manager enables you to view and edit cookies that are associated with different domains. - [Understanding examples](https://learning.postman.com/docs/sending-requests/response-data/examples/): Examples show your API endpoints in action and give more details on how requests and responses work. - [View and save responses](https://learning.postman.com/docs/sending-requests/response-data/response-data/): An API response is the data returned by an API server after it receives a request from a client. - [Response body](https://learning.postman.com/docs/sending-requests/response-data/responses/): The Postman response viewer helps you visualize and check the correctness of API responses. - [Troubleshooting your requests](https://learning.postman.com/docs/sending-requests/response-data/troubleshooting-api-requests/): If an API request isn't behaving as expected, there can be many possible reasons. - [Visualize response data](https://learning.postman.com/docs/sending-requests/response-data/visualizer/): The Postman Visualizer provides a programmable way to visually represent your request responses. ### soap - [Enter your SOAP endpoint](https://learning.postman.com/docs/sending-requests/soap/making-soap-requests/): Postman can make HTTP calls using Simple Object Access Protocol (SOAP), a platform-independent messaging protocol specification. ### variables - [Edit environment variables](https://learning.postman.com/docs/sending-requests/variables/environment-variables/): An environment is a group of variables whose values you can change depending on your work context in Postman. - [Create an environment](https://learning.postman.com/docs/sending-requests/variables/managing-environments/): In Postman, an environment is a set of one or more variables that you can reference when sending requests, writing pre-request scripts... - [Pin an environment to a collection](https://learning.postman.com/docs/sending-requests/variables/pinned-environments/): Pin environments to an HTTP collection to organize your workspace and show other Postman users which environments work with that collection. - [Move an environment to a shared workspace](https://learning.postman.com/docs/sending-requests/variables/team-environments/): An environment enables you to collaborate on Postman data when you're working as part of a team. - [Variables quick start](https://learning.postman.com/docs/sending-requests/variables/variables-intro/): A variable is a reusable value you can use in API requests and scripts. Postman uses the variable's local value when running a request or script. - [Understanding variables](https://learning.postman.com/docs/sending-requests/variables/variables/): Variables enable you to store and reuse values in Postman. ### websocket - [add-details-websocket](https://learning.postman.com/docs/sending-requests/websocket/add-details-websocket/): Add details to your WebSocket or Socket.IO request, such as parameters, headers, and connection settings. - [create-a-socketio-request](https://learning.postman.com/docs/sending-requests/websocket/create-a-socketio-request/): Socket.IO is a library that abstracts WebSockets and provides extra features like event-based messaging. You can create Socket. - [create-a-websocket-request](https://learning.postman.com/docs/sending-requests/websocket/create-a-websocket-request/): Create a WebSocket request from the sidebar in Postman. 1. Click New > WebSocket to open a raw WebSocket request in a new tab. - [document-websocket-requests](https://learning.postman.com/docs/sending-requests/websocket/document-websocket-requests/): Postman automatically generates documentation for each of your requests. - [listen-to-socketio-events](https://learning.postman.com/docs/sending-requests/websocket/listen-to-socketio-events/): Configure Socket.IO requests to listen to specific events. The Response pane displays the received events that the request is listening to. - [save-websocket-requests](https://learning.postman.com/docs/sending-requests/websocket/save-websocket-requests/): Save your WebSocket requests to a collection. This enables you to reuse requests, share them with other team members... - [troubleshoot-websocket-requests](https://learning.postman.com/docs/sending-requests/websocket/troubleshoot-websocket-requests/): Use the Postman Console to debug issues with a WebSocket connection. To open the Console and view log messages, select Console in the Postman footer. - [use-variables-with-websocket](https://learning.postman.com/docs/sending-requests/websocket/use-variables-with-websocket/): Use Postman variables in the URL of a WebSocket connection or the body of a message. - [Next steps](https://learning.postman.com/docs/sending-requests/websocket/websocket-overview/): Postman supports the WebSocket protocol. The WebSocket protocol provides a way to exchange data between a client and a server over a persistent connection. - [Send WebSocket messages](https://learning.postman.com/docs/sending-requests/websocket/work-with-websocket-messages/): WebSocket messages are data packets sent over a WebSocket connection. ## tests and scripts ### run tests - [Run a single test](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests-manually/): In Postman, you can run your functional API tests at any time. Running tests manually enables you to run tests on demand and view the results right away. - [Run tests on a schedule](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests-on-schedule/): In Postman, you can run your functional API tests automatically on a schedule. - [Configure Postman CLI test runs](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests-with-ci-cd/): The goal of continuous integration and continuous delivery (CI/CD) is to deliver frequent software updates that provide value for users. - [run-tests](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests/): Testing is a critical part of the API development lifecycle. Postman provides a variety of ways you can run your API tests. - [Monitoring an API endpoint](https://learning.postman.com/docs/tests-and-scripts/run-tests/test-with-monitors/): Postman Monitors provide a way to automatically run post-response scripts and perform tests at regular intervals. ### test apis - [About end-to-end testing](https://learning.postman.com/docs/tests-and-scripts/test-apis/end-to-end-testing/): While unit testing focuses on individual requests and responses, end-to-end testing puts these pieces together to test complex user journeys. - [About integration testing](https://learning.postman.com/docs/tests-and-scripts/test-apis/integration-testing/): As an application grows, it's important to make sure each of its components work together as expected. - [About performance testing](https://learning.postman.com/docs/tests-and-scripts/test-apis/performance-testing/): To ensure user success, it's not enough for your APIs to support the required functionality. Your APIs also need to handle the expected traffic volume. - [About regression testing](https://learning.postman.com/docs/tests-and-scripts/test-apis/regression-testing/): Regression testing plays a vital role in maintaining the overall quality and performance of your API. - [test-apis](https://learning.postman.com/docs/tests-and-scripts/test-apis/test-apis/): Testing is a critical part of the API development lifecycle. - [Add logic and process data with scripts](https://learning.postman.com/docs/tests-and-scripts/tests-and-scripts/): In an API-first world, APIs are developed before the rest of an application. That means API testing happens earlier in the API lifecycle. ### write scripts - [Scripts in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/intro-to-scripts/): Postman's runtime is based on Node.js. You can use this to write scripts that add dynamic behavior to requests and collections. #### packages - [Import a public package](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/external-package-registries/): Import public packages from external package registries into your scripts. Postman supports importing public packages from npm and JSR registries. - [Create and import internal scripts as packages](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/overview/): Import packages from your team's Package Library into scripts in your internal workspaces. - [About the package library](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/package-library/): With the Package Library, you can maintain scripts and tests in a central location and share them with your team. - [Use variables in scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-api-reference/): The Postman JavaScript API functionality enables you to programmatically access and alter request and response data and variables using the pm object. - [Pre-request scripting example](https://learning.postman.com/docs/tests-and-scripts/write-scripts/pre-request-scripts/): Use pre-request scripts in Postman to run JavaScript before a request runs. - [Use multiple assertions](https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-examples/): This page provides post-response script examples for various API testing scenarios in Postman. - [Testing in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-scripts/): Use post-response scripts in Postman to run JavaScript after a request runs. - [Common](https://learning.postman.com/docs/tests-and-scripts/write-scripts/variables-list/): The Faker library enables you to generate sample data in Postman using predefined variables. Use these variables like you would any other variable in Postman. --- ## Exclude from AI context - Sidebars - Navigation menus - Footer - Ads - Non-content scripts --- ## How to use this file - This file is intended for AI agents, LLMs, and search tools to quickly understand and prioritize the most important content on this site. - For best results, use the provided links and summaries to guide AI context and avoid irrelevant site elements. - This file is not a standard yet, but is provided for improved AI accuracy and citation.