# 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) ## Administer Postman - [Admin FAQs](https://learning.postman.com/docs/administration/admin-faqs/): For administrative and team management frequently asked questions, check out Postman's [Help Center](https://support.postman.com/hc/en-us). - [Administer Postman](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. Whether you're setting up a new team or managing an existing one, you can customize your team's experience to align with your organization's goals. ### Domain verification and capture - [Verify your organization's domain in Postman](https://learning.postman.com/docs/administration/domain-verification-and-capture/add-and-verify-a-domain/): **[Domain verification is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Domain capture FAQs](https://learning.postman.com/docs/administration/domain-verification-and-capture/domain-capture-faqs/): **[Domain verification is available with Postman Enterprise plans. Domain capture is available with Postman Enterprise plans with the Advanced Security Administration add-on.](https://www.postman.com/pricing/)** - [Configure domain verification and account capture in Postman](https://learning.postman.com/docs/administration/domain-verification-and-capture/domain-capture-overview/): **[Domain verification is available with Postman Enterprise plans. Domain capture is available with Postman Enterprise plans with the Advanced Security Administration add-on.](https://www.postman.com/pricing/)** - [Enable domain capture in Postman](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.](https://www.postman.com/pricing/)** ### Postman Enterprise - [Postman 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 residency requirements. If you select the EU Data Residency, your data will be stored in EU data centers. An instance of Postman hosted in `eu-central-1` (Frankfurt) is available for new Enterprise customers. - [Postman Enterprise plans](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, and deploy APIs. Postman Enterprise enables you to deploy Postman at scale, manage your team, and streamline your organization's API development process. - [Enterprise onboarding checklist](https://learning.postman.com/docs/administration/enterprise/enterprise-onboarding/): To set up a productive Enterprise team in Postman, walk through the following general tasks. It's recommended that you first identify your Admins, Super Admins, and Billing users, then set up your Identity Provider (IdP), verify your domains, and assign groups and roles to your users before you enable your Enterprise team. - [Postman 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, testing, and deployment at scale. Position your Enterprise team for success by setting up and managing secure Postman access across your organization. - [Enterprise deployment](https://learning.postman.com/docs/administration/enterprise/managing-enterprise-deployment/): Postman app versioning and the Postman Enterprise App are available with **[Postman Enterprise plans](https://www.postman.com/pricing/)**. ### Team management - [Audit logs](https://learning.postman.com/docs/administration/managing-your-team/audit-logs/): **[Audit logs are available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [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.](https://www.postman.com/pricing/#advanced-security-administration)** - [Create a team in Postman](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. To collaborate with more team members, features, and increased usage limits, see [Plans and Pricing](https://www.postman.com/pricing/). - [Manage product access](https://learning.postman.com/docs/administration/managing-your-team/manage-team-product-access/): **[Add-on availability varies according to your Postman plan.](https://www.postman.com/pricing/)** - [Manage team resources in Postman](https://learning.postman.com/docs/administration/managing-your-team/manage-team-workspaces/): As a [Super Admin or Team Admin](/docs/administration/roles-and-permissions/#team-roles), you can manage resources in your team workspaces in alignment with your organizational goals. Manage which team members can create team workspaces and share collections with guest users, manage mock server privacy settings, and decide which external packages are allowed in scripts. - [Manage API keys](https://learning.postman.com/docs/administration/managing-your-team/managing-api-keys/): **[Postman API key management is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Team management overview](https://learning.postman.com/docs/administration/managing-your-team/overview/): Some team options are only available on [Postman Professional and Enterprise plans](https://www.postman.com/pricing/). #### Secret Scanner - [How the Secret Scanner works](https://learning.postman.com/docs/administration/managing-your-team/secret-scanner/how-secret-scanner-works/): The Secret Scanner [scans public workspaces](#automatically-replace-secrets-detected-in-public-workspaces) and published documentation to detect exposed secrets on all Postman plans. Secret Scanner is turned on by default for public workspaces with all Postman plans and scans for: - [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. It monitors the collections, global variables, environment variables, API specifications, and documentation in public workspaces. Secret Scanner helps safeguard your organization from potential threats and malicious users attempting to access any exposed secrets. It also scans the documentation your team has [published](/docs/publishing-your-api/publishing-your-docs/), regardless of the type of workspace it's found in. - [The Secret Scanner dashboard](https://learning.postman.com/docs/administration/managing-your-team/secret-scanner/secret-scanner-dashboard/): The Secret Scanner dashboard is available with [Postman Enterprise plans](https://www.postman.com/pricing/). - [Secret Scanner 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. By default, the Secret Scanner searches using a variety of [default secret patterns](#default-patterns). You can also add your team's proprietary third-party app tokens that aren't supported yet using [custom patterns](#custom-patterns) in the [Secret Scanner dashboard](/docs/administration/managing-your-team/secret-scanner/secret-scanner-dashboard/). #### Manage team members - [Invite members to your Postman team](https://learning.postman.com/docs/administration/managing-your-team/team-members/invite-members/): You can invite people to join your team, enable coworkers who aren't part of your team to view and send requests in specific collections, and invite external partners to collaborate using Partner Workspaces. Manage your team invites in the [team dashboard](https://go.postman.co/settings/team/invites). - [Manage roles in Postman](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. Roles can be granted to team members individually, or to members of a [group](/docs/administration/managing-your-team/user-groups/). - [Team membership 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](https://www.postman.com/pricing/). - [Scale your Postman team](https://learning.postman.com/docs/administration/managing-your-team/team-members/scale-team/): You can change your team size to accommodate more collaborators at any time in your billing cycle. You can also remove members as needed. Learn more about the [workspace and data management dependencies](#remove-team-members) of member removal. - [Configure team settings](https://learning.postman.com/docs/administration/managing-your-team/team-settings/): Your [Team Settings](https://go.postman.co/settings/team/general) enable you to manage items such as your team's publisher profile, discoverability, custom domains, authentication, and active invite links. - [Organize users into Postman groups](https://learning.postman.com/docs/administration/managing-your-team/user-groups/): **[Groups are available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Onboarding checklist](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. It's recommended that you first collaborate with your identified Team Admins and your organization's IT team to set up, secure, and manage Postman in your organization. Then you can set up your Postman team by configuring relevant settings, inviting people to your team and assigning them roles, and creating workspace resources related to your projects. - [Define roles and permissions within a Postman team](https://learning.postman.com/docs/administration/roles-and-permissions/): Certain team options are only available with **[paid plans](https://www.postman.com/pricing/)**. To learn which roles are available with your plan, go to your **[web dashboard](https://go.postman.co/settings/team/roles)**. ### SCIM provisioning - [Configure SCIM with 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), allowing you to automate user provisioning and de-provisioning for your team. - [Configure SCIM with Okta](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](#set-up-scim-in-okta-with-postman-okta-app) or the [SCIM 2.0 test app (Header Auth)](#set-up-scim-in-okta-with-scim-test-app). These apps enable you to automate user provisioning and de-provisioning for your team. - [Configure SCIM with 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](https://www.onelogin.com/) with the Postman OneLogin app, enabling you to automate user provisioning and de-provisioning for your team. - [SCIM provisioning overview](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/): **[Provisioning with SCIM is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** ### Security - [Security for Postman developers](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, limiting your workspace visibility, and storing your secrets in Postman Vault. - [Postman security features](https://learning.postman.com/docs/administration/security/overview/): Data security is a shared responsibility between Postman and its users. Postman maintains compliance with global industry security standards, manages vulnerabilities to secure Postman code, and fosters a security-first culture. Postman's security program and processes are consistent with best practices and industry standards. Postman also embeds security into the product to make it safe and secure to use. - [Security for Postman teams](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, and a token scanner that searches for exposed sensitive information. ### Single Sign-On (SSO) - [Configure SSO for a team](https://learning.postman.com/docs/administration/sso/admin-sso/): **[SSO is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Microsoft Entra ID](https://learning.postman.com/docs/administration/sso/azure-ad/): **[SSO with Microsoft Entra ID is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Custom SAML](https://learning.postman.com/docs/administration/sso/custom-saml/): **[SSO with custom SAML is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Duo](https://learning.postman.com/docs/administration/sso/duo/): **[SSO with Duo is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Google Workspace](https://learning.postman.com/docs/administration/sso/google-workspace/): **[SSO with Google Workspace is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Intro to SSO](https://learning.postman.com/docs/administration/sso/intro-sso/): **[SSO is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Microsoft AD FS](https://learning.postman.com/docs/administration/sso/microsoft-adfs/): **[SSO with Microsoft AD FS is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Okta](https://learning.postman.com/docs/administration/sso/okta/): **[SSO with Okta is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [OneLogin](https://learning.postman.com/docs/administration/sso/onelogin/): **[SSO with OneLogin is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Ping Identity](https://learning.postman.com/docs/administration/sso/ping-identity/): **[SSO with Ping Identity is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [SSO and SCIM FAQs](https://learning.postman.com/docs/administration/sso/sso-faqs/): The following are frequently asked questions about configuring and using [single sign-on (SSO)](/docs/administration/sso/intro-sso/) and [SCIM (System for Cross-domain Identity Management)](/docs/administration/scim-provisioning/scim-provisioning-overview/) in Postman. - [Sign in to an SSO team](https://learning.postman.com/docs/administration/sso/user-sso/): **[SSO is available with Postman Enterprise plans.](https://www.postman.com/pricing/)** - [Migrate data between teams](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. There are several reasons for having a company-authorized Postman account (or team) including security, the ability for a company to better oversee its intellectual property, and to give users the benefit of a robust paid plan. ## Native Git - [Get started with Postman AI](https://learning.postman.com/docs/agent-mode/get-started/): You can access Agent Mode directly from the [Homepage](https://go.postman.co). Type in your query or use one of the suggestions. Click **Let's go**, and you'll be taken to your most recently visited workspace with edit access. When the workspace opens, Agent Mode will already be loaded with your query. - [About Native Git](https://learning.postman.com/docs/agent-mode/native-git/): Native Git support enables you to locally work on your API project files in Postman. You can load a repo folder containing your API code using the source files stored in your Git-based version control system. Then you can design and develop your APIs directly in Postman using the Postman Collection format you’re familiar with. Leverage Native Git to help keep your collection and project files in sync, then commit your local changes to your version control system’s remote repository. - [Postman Agent Mode](https://learning.postman.com/docs/agent-mode/overview/): Postman Agent Mode is available on Free, Basic, and Professional plans to users who consent to using AI. - [Agent Mode settings](https://learning.postman.com/docs/agent-mode/settings/): To turn off Agent Mode, click Setting icon **Settings > AI** and toggle off **Try Agent Mode**. - [Run automated tasks with Postman AI Skills](https://learning.postman.com/docs/agent-mode/skills/): Agent Mode has built-in "recipes" for accomplishing certain meaningful tasks by combining one or more tools with specific configurations. These tasks are called Skills. - [Troubleshoot Agent Mode](https://learning.postman.com/docs/agent-mode/troubleshoot/): If you get stuck, click Add icon in the upper right corner to start a new chat. You can also view and continue any previous conversation by clicking History icon. ## API Governance ### API rules - [Track governance and security rule violations in the API definition](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](/docs/api-governance/api-definition/openapi3/), [OpenAPI 3.0](/docs/api-governance/api-definition/openapi3/), and [OpenAPI 2.0](/docs/api-governance/api-definition/openapi2/) formats in both [API Builder](#check-rule-violations-in-the-api-builder) and [Spec Hub](#check-rule-violations-in-spec-hub). - [OpenAPI 2 security and formatting warnings](https://learning.postman.com/docs/api-governance/api-definition/openapi2/): You can use Postman to identify any potential security and formatting issues when defining your API. - [OpenAPI 3 security and formatting warnings](https://learning.postman.com/docs/api-governance/api-definition/openapi3/): You can use Postman to identify any potential security and formatting issues when defining your API. - [API Governance and API Security in Postman](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. [Learn more about Postman plans](https://www.postman.com/pricing/). ### API request warnings - [View security warnings in API requests](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. A security warning doesn't mean your API is broken. Instead, it indicates there are potential security risks your API might be vulnerable to. Postman highlights these security warnings and helps you understand their implications and possible ways to fix the warnings. - [Security warnings in API requests](https://learning.postman.com/docs/api-governance/api-testing/security-warnings/): You can use Postman to identify any potential security risks your API might be vulnerable to. ### Configurable rules - [Enforce API governance and security rules for your team in Postman](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/): Configurable API governance rules are available with Postman Enterprise plans. Configurable API security rules are available with Postman Enterprise plans with the API Builder add-on. [Learn more about Postman plans](https://www.postman.com/pricing/). - [Configure API Governance rules in Postman](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-api-governance-rules/): Configurable governance rules are available with [Postman Enterprise plans](https://www.postman.com/pricing/). If you don't have an Enterprise account, you'll be able to see the API Governance page, but you won't be able to add new rules. - [Manage API Security rules in Postman](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.](https://www.postman.com/pricing/) If you don't have an Enterprise account, you'll be able to see the API Security page, but you won't be able to turn rules on or off. - [Create custom governance functions in Postman](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-custom-governance-functions/): [API Governance custom functions are available with Postman Enterprise plans.](https://www.postman.com/pricing/) If you don't have an Enterprise account, you'll be able to see the API Governance page, but you won't be able to configure custom functions. - [Define custom governance rules using Spectral](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. Postman supports Spectral v6 rules for the configurable [API Governance and Security](/docs/api-governance/configurable-rules/configuring-api-governance-rules/#add-custom-rules) rules for your team. Postman also supports ES6 syntax and CommonJS syntax for custom functions configurable in custom governance rules. ## Billing - [Manage your Postman AI credits](https://learning.postman.com/docs/billing/agent-mode-usage/): Agent Mode is available with [Free, Basic, and Professional plans](https://www.postman.com/pricing/). To learn more, see [About Postbot](/docs/getting-started/basics/about-postbot/). - [Billing overview](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. With these billing features, you can ensure your team has access to the Postman features they need to be successful. - [Manage billing](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. - [Purchase Postman](https://learning.postman.com/docs/billing/buying/): Visit the [pricing page](https://www.postman.com/pricing/) to purchase a Postman Basic, Professional, or Enterprise plan. Select __Buy Now__ for your chosen plan. If you're [upgrading from an existing paid account](/docs/billing/billing/#team-and-plan-changes), you can use the links in your [billing dashboard](http://go.postman.co/billing). - [Manage your team's Postman Flows credit 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](#how-flow-modules-and-actions-consume-credits) each month. The amount of credits you get depends on your [Postman plan](https://www.postman.com/pricing/#postman-flows-add-on-pricing) and whether you purchased the Flows [add-on](/docs/billing/billing/#purchasing-add-on-products). You consume credits when certain blocks are triggered and each time an action runs in the cloud. - [About resource usage](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](https://www.postman.com/pricing/). Monthly resources include calls to the Postman API, requests made by monitors and scheduled collection runs, mock server requests, and Cloud Agent requests. Your Postman plan also has other limits, such as the number of integrations you can create, the number of custom domains, and storage for uploaded images. ## Collaborate in Postman - [API collaboration features in Postman](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. With Postman's many API collaboration capabilities, you can organize, share, comment on, announce, and publish your work. - [Collaborate 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](https://www.postman.com/postman-best-practices/). You can design and implement an API lifecycle, organize your team and work, communicate changes, and share your work internally and with the world. With these features, you can tailor your collaboration strategy to each project's specific goals. - [Collaboration concepts](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, company, and across the planet. In this topic, you'll learn about the types of teams and workflows for internal and external API collaboration in Postman. - [Collaborate in Postman using comments](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. Through interactive communication, commenting removes ambiguity, improves user experience, and helps to increase the adoption of API-driven services. - [Collaborate in Postman with Live Sessions](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](https://www.postman.com/pricing/). - [Manage public elements in Postman](https://learning.postman.com/docs/collaborating-in-postman/manage-public-elements/): The Manage public elements dashboard is available with **[Postman Enterprise plans.](https://www.postman.com/pricing/)** ### Private API Network - [Manage folders and elements in your Private API Network](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.](https://www.postman.com/pricing/)** - [Add elements to your Private API Network](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.](https://www.postman.com/pricing/)** - [Share elements on your Postman 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.](https://www.postman.com/pricing/)** - [Request to add elements to your Private API Network](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.](https://www.postman.com/pricing/)** - [Automate publishing to your Private API Network using the Postman API](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.](https://www.postman.com/pricing/)** - [Explore your Postman 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.](https://www.postman.com/pricing/)** ### Postman API Network - [Explore and Publish to 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. Publishers can help their API's consumers to discover and consume their APIs directly in Postman. The Postman API Network enables API consumers to discover new and popular public workspaces and elements to use in their own workspaces. - [Request and approve access to Postman resources](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, and team membership when links to resources are shared outside the team. It covers requesting access and managing permissions within internal workspaces. Using this guide, both users and workspace administrators can control access to workspaces for secure collaboration across teams. - [Share your work in Postman](https://learning.postman.com/docs/collaborating-in-postman/sharing/): Postman enables you to [collaboratively iterate on your APIs](https://www.postman.com/api-platform/api-collaboration/) with developers, testers, architects, and other business stakeholders. You can share your work in Postman by sharing your workspace. You can also share individual Postman elements including collections, requests, examples, and [flows](/docs/postman-flows/overview/). - [Collaborate with your team in Postman](https://learning.postman.com/docs/collaborating-in-postman/use-teams/): Collaborate with others in Postman using internal workspaces. You can [find a team](#find-teams-within-your-organization) within your organization or [join by other means](#join-a-team) enabled by your organization. If you sign up for a Postman free plan as an individual user, you can create a team during Postman onboarding or later, where up to three users can work together at no cost. ### Version control - [Create a pull request to contribute to an element you forked](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/creating-pull-requests/): You can contribute to a collection or environment you forked with a *pull request* (Postman Flows doesn't support this feature). When you create a pull request, you ask others to review your changes to the element you forked. These reviewers can add comments to the request and approve your changes before your merge them. This is an example of version control. - [Fork collections and environments in Postman](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. Forking enables you to contribute to an element without having [Editor access](/docs/administration/roles-and-permissions/#element-based-roles) for that element. - [Review pull requests in Postman](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, and merge the forked collection or environment into the parent element. - [Version control for Postman collections and environments](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. Learn how to fork a collection or environment, make updates to the fork, create a pull request, and merge your changes into the parent element. - [Watch pull requests in Postman](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. If you watch a pull request, you will get notifications about actions such as adding a new comment, approving or removing approval, merging, and editing or declining a pull request. ### Workspaces - [Create a workspace in Postman](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/create-workspaces/): When you first sign in to Postman, an [internal workspace](/docs/collaborating-in-postman/using-workspaces/overview/) is automatically created for you. You can create new workspaces using a blank workspace or use a template suitable for the work you and your team are doing. #### Internal workspaces - [Manage Postman workspaces](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. Learn more about managing the workspace roles, editing and sharing workspaces, responding to requests to create workspaces, and moving elements and whole workspaces. - [Collaborate with your team in Postman](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. Once you're ready, you can share them with your [partners](/docs/collaborating-in-postman/using-workspaces/partner-workspaces/overview/) or [the world](/docs/collaborating-in-postman/using-workspaces/public-workspaces/). - [Use Postman workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/use-workspaces/): When you first open Postman, you'll land in your default internal workspace. You can [create more workspaces](/docs/collaborating-in-postman/using-workspaces/create-workspaces/) for your use and to work with teammates. To create more workspaces, you need to sign in to your [Postman account](/docs/getting-started/account/overview/). - [Communicate API changes using workspace updates](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. API publishers can share updates across multiple collections, with links to the resources that changed. API consumers who fork or watch a workspace get notified and can engage with these updates by visiting, commenting, and reacting. - [Workspaces overview](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/overview/): Workspaces enable you to organize your Postman work and collaborate with teammates. You can group your projects together, with workspace acting as the single source of truth for related APIs, collections, environments, mocks, monitors, and other linked elements. By collaborating in a workspace, your edits sync with your team in real time. #### Partner Workspaces - [Collaborate in a Partner Workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/collaborate/): **[Partner Workspaces are available with Postman Professional and Enterprise plans.](https://www.postman.com/pricing/)** - [Team-to-team Partner Workspaces FAQ](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/faq/): Starting in May 2025, you can create _team-to-team Partner Workspaces_. This update enhances security and authentication for Postman API partnerships and enables access to a Partner Workspace from one's own team. In addition to supporting SSO login for partners, Partner Managers can verify which partners use SSO from a new [**Partnerships**](https://go.postman.co/settings/team/partnerships/external-partners) page in **Team Settings**. - [Manage Partner Workspaces in Postman](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/manage/): **[Partner Workspaces are available with Postman Professional and Enterprise plans.](https://www.postman.com/pricing/)** - [Collaborate with multiple partners using 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.](https://www.postman.com/pricing/)** - [Collaborate with external partners in Postman using Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/overview/): **[Partner Workspaces are available with Postman Professional and Enterprise plans.](https://www.postman.com/pricing/)** - [Set up 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. Your partners can use domain capture and SSO to authenticate to your Partner Workspaces and you can track your partnerships in a new team setting called [**Partnerships**](/docs/collaborating-in-postman/using-workspaces/partner-workspaces/manage/#manage-your-partnerships). That means no switching between teams and more control over partnerships. If you have older Partner Workspaces, they'll continue to work as-is. See the [FAQ](/docs/collaborating-in-postman/using-workspaces/partner-workspaces/faq/) and take advantage of the [new capabilities](https://www.postman.com/release-notes/postman-app/#11-46-2). - [Collaborate with the Postman community using public workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/public-workspaces/): Anyone in the Postman community can access a _public workspace_. A public workspace can enhance a new user's onboarding experience with your API, inspire your existing users with new use cases and resources, increase your API's discovery in Postman search results, and enable you to work publicly with partners. ## Postman Collections - [Organize and automate API requests in Postman Collections](https://learning.postman.com/docs/collections/collections-overview/): [_Postman Collections_](https://www.postman.com/collection/) are portable sets of API requests that you can reuse, automate, and share with others. You can use a collection to save important details for each API request, such as the authorization type, parameters and headers, request bodies, scripts and variables, and documentation. ### Performance testing - [Configure and run performance tests in Postman](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](/docs/collections/running-collections/intro-to-collection-runs/). When you run a performance test, Postman uses the requests in the selected collection to simulate the activity of your API users. - [Use a data file to simulate virtual users](https://learning.postman.com/docs/collections/performance-testing/performance-test-data-files/): When you [configure a performance test](/docs/collections/performance-testing/performance-test-configuration/), you specify a number of _virtual users_. During the test, each virtual user (VU) runs the selected requests in the specified order in a repeating loop. You can customize the behavior of the virtual users by importing a CSV or JSON file - [View error details for performance tests](https://learning.postman.com/docs/collections/performance-testing/performance-test-errors/): During a [performance test](/docs/collections/performance-testing/performance-test-configuration/), requests that result in a response other than a 2xx status code are tracked as errors. You can view details about the top errors that occurred during the test and error trends over time. Use this information to gain insight into when errors are occurring and the possible causes. - [View metrics for performance tests](https://learning.postman.com/docs/collections/performance-testing/performance-test-metrics/): During a [performance test](/docs/collections/performance-testing/performance-test-configuration/), all requests are sent from your computer where you are running the Postman desktop app. You can view real-time metrics such as the average response time, error rate, and throughput. You can also customize the performance test graph to focus on the requests or test metrics you're most interested in. - [Simulate user traffic to test your API performance](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. You can observe how your API behaves under load and identify potential issues or bottlenecks that affect performance. ### Run collections - [Customize request order in a collection run](https://learning.postman.com/docs/collections/running-collections/building-workflows/): By default, when you [run a collection](/docs/collections/running-collections/intro-to-collection-runs/), Postman runs all requests in the order they appear in your collection. Requests in folders run first, followed by requests in the root of the collection. To dynamically change the order of requests during a collection run, use the `pm.execution.setNextRequest()` function in a post-response [script](/docs/tests-and-scripts/write-scripts/intro-to-scripts/). - [Trigger collection runs using webhooks](https://learning.postman.com/docs/collections/running-collections/collection-webhooks/): A webhook provides a way to automatically send data from one application to another. Using a webhook, you can trigger a [collection run](/docs/collections/running-collections/intro-to-collection-runs/) at a specific time or when an event occurs. When the webhook is triggered, Postman runs the collection using a [monitor](/docs/monitoring-your-api/intro-monitors/). - [Test your API using the Collection Runner](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_. The Collection Runner logs the [test results](/docs/tests-and-scripts/write-scripts/test-scripts/) for each request, and it can use [scripts](/docs/tests-and-scripts/write-scripts/intro-to-scripts/) to pass data between requests and change the request workflow. - [Test your API functionality](https://learning.postman.com/docs/collections/running-collections/running-collections-overview/): You can run Postman Collections to test and interact with your APIs. In Postman, a collection can be a group of saved [requests](/docs/getting-started/first-steps/sending-the-first-request/), a [workflow](/docs/collections/running-collections/building-workflows/), or a [test suite](/docs/tests-and-scripts/write-scripts/test-scripts/). When you run a collection, Postman sends some or all of the requests in the collection in the order you choose. - [Automate collection runs using Postman Monitors](https://learning.postman.com/docs/collections/running-collections/scheduling-collection-runs-monitors/): You can automate [collection runs](/docs/collections/running-collections/intro-to-collection-runs/) using [Postman monitors](/docs/monitoring-your-api/intro-monitors/). Create a new monitor, select a collection, and configure a schedule. Postman will run the collection at the scheduled times in the Postman Cloud. You'll get an alert if there are any errors or failures. - [Automate collection runs on a schedule](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. Use the Collection Runner to select a collection and configure a schedule. For example, you can run a collection that tests the functionality of your API every day at a specific time. - [View scheduled collection runs in Postman](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 the Collection Runner to [schedule collections to run automatically](/docs/collections/running-collections/scheduling-collection-runs/) at specified dates and times. - [Run collections using imported data](https://learning.postman.com/docs/collections/running-collections/working-with-data-files/): When you configure a [manual](/docs/collections/running-collections/intro-to-collection-runs/) or [scheduled](/docs/collections/running-collections/scheduling-collection-runs/) collection run, you can choose to use custom data for each iteration. Select a valid CSV or JSON file with data you want to use. When you run the collection, Postman uses data from the file to populate [variables](/docs/sending-requests/variables/variables/) in the collection's requests. ### Create and manage collections - [Add API requests to Postman Collections](https://learning.postman.com/docs/collections/use-collections/add-requests-to-collections/): After you [create a Postman Collection](/docs/collections/use-collections/create-collections/), you can use it to save and organize API requests. Use any of the methods below to add requests to a collection. You can add HTTP requests to a collection, or you can add requests that use other protocols to a [multi-protocol collection](#about-multi-protocol-collections). - [Share and collaborate on Postman Collections](https://learning.postman.com/docs/collections/use-collections/collaborate-with-collections/): You can collaborate on Postman Collections with your team and other Postman users. Share collections with others, watch collections to get notified when changes are made, and comment on collections to let others know your thoughts. You can also use collection tags to help organize and find collections. - [View collection activity and elements with the 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. Collaborators can check this tab to view the collection's description, recent changes, pinned environments, monitors, mocks, and more. - [Create collections of API requests in Postman](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. You can create a new collection from scratch, or jump-start your collection with a template. - [Manage and organize Postman Collections](https://learning.postman.com/docs/collections/use-collections/manage-collections/): You can save, organize, and find all of your API requests in Postman Collections. Use folders to group requests by type or use case, and reorder requests to replicate workflows. You can also reorder requests alphabetically. If you don't want to keep a change, you can revert your collection to an earlier state. - [Create and manage request collections in Postman](https://learning.postman.com/docs/collections/use-collections/use-collections-overview/): A _collection_ is one of the fundamental [elements](/docs/getting-started/basics/postman-elements/) in Postman. Use collections to save all your API requests, keep them organized, and find them when you need them. When you're ready, you can share your collections with other members of your team—or anyone in the world. ### Newman CLI - [Run and test collections from the command line using Newman CLI](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. Newman is built with extensibility in mind, so you can incorporate it in your continuous integration (CI) pipelines and build systems. - [Run Postman Collections in your CI environment using Newman](https://learning.postman.com/docs/collections/using-newman-cli/continuous-integration/): You can use [Newman](/docs/collections/using-newman-cli/command-line-integration-with-newman/) and the [Postman API](https://api.postman.com/) to run Postman Collections in your continuous integration (CI) environment. First install Node.js and Newman in your CI environment. You can then use Newman to get and run your collection using the Postman API. - [Install and run Newman](https://learning.postman.com/docs/collections/using-newman-cli/installing-running-newman/): Newman is built on [Node.js](https://nodejs.org/en/about). To get started, first install Node.js, then install Newman. After installing Newman, you can run your Postman collections from the command line. Collections can be run as an exported JSON file or by passing the URL of the collection to Newman. - [Integrate your Postman tests with Jenkins using Newman](https://learning.postman.com/docs/collections/using-newman-cli/integration-with-jenkins/): [Jenkins](https://www.jenkins.io/) is an open source automation server that can act as a continuous integration (CI) server or a continuous delivery (CD) hub. Use Newman to integrate your [Postman tests](/docs/tests-and-scripts/write-scripts/test-scripts/) with Jenkins. You can run a Postman Collection and its API tests from Jenkins. You can also specify the frequency that Jenkins runs a collection. - [Integrate your Postman tests with Travis CI using Newman](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 on a regular basis. With CI/CD, developers might commit their code as often as several times a day. This approach helps the team avoid technical debt and detect problems. - [Generate collection run reports with Newman 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. The following reporters are available: CLI, JSON, JUnit, Progress, and Emoji train. You can use more than one reporter for a run, and you can customize the report output to meet your needs. - [Use Newman external and 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. You can generate reports for specific use cases, for example, logging the response body when a request or test fails. Use existing external reporters to generate reports, or build your own custom reporters. - [Upload test data files with Newman](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. The data file must be located in the same [working directory](/docs/getting-started/installation/settings/#working-directory) as the collection JSON file you are running. Also, you must include the filename in the `src` attribute of the request. - [Newman command reference](https://learning.postman.com/docs/collections/using-newman-cli/newman-options/): Use Newman's command line options to customize your collection runs. You can use options to set up a collection run, configure request delays and timeouts, specify SSL details, and more. When you run a collection iteratively, you can [specify different data sets and variables](#data-file-example) for each iteration. After a run finishes, Newman exits with a [status code](#exit-status) that you can pass to your continuous integration (CI) tool. - [Run Newman with Docker on macOS, Ubuntu, and Windows](https://learning.postman.com/docs/collections/using-newman-cli/newman-with-docker/): [Docker](https://www.docker.com/) is a platform for building and running applications in a virtual environment. You can use [Newman](/docs/collections/using-newman-cli/command-line-integration-with-newman/) to run your Postman Collections in a Docker container. When running collections in Docker, you can use all available Newman command options and run local collection files. ## Design and build APIs ### Develop APIs with the API Builder - [Create an API in the Postman API Builder](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. Postman supports version control and a variety of API definition types such as protobuf (protocol buffers), OpenAPI (formerly Swagger), WSDL, RAML, and GraphQL. #### Deploy an API - [Manage API deployments in the Postman API Builder](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. When you connect Postman to an API gateway, you can track your API deployment status and history. Postman offers integration with popular API gateways, such as [Apigee X](https://cloud.google.com/apigee), [Amazon API Gateway](https://aws.amazon.com/api-gateway/), and [Azure API Management](https://azure.microsoft.com/en-us/services/api-management/). #### Develop an API - [Add elements to an API in the Postman API Builder](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. - [Work with API definitions in the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/defining-an-api/): You create the structure of your API using the _API definition_. The API definition can consist of one or multiple files. If your API doesn't have a definition, you can add an example definition, import a definition, or add a definition from a connected repository. - [Generate server-side code in the Postman API Builder](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. This enables you to run a server based on your API specification and use it as a starting point for developing your business logic. - [Define and develop your API in the Postman API Builder](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. Create or import common API definition types, including OpenAPI, GraphQL, Protobuf, RAML, and WSDL. Postman automatically validates requests and checks for errors as you work on your API. - [Check for validation and syntax errors in the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/develop-apis/validating-elements-against-schema/): You can validate collections that are linked to an API to make sure the API implementation is consistent with the API definition. Postman automatically compares requests and saved examples in the collection to the API definition and alerts you to any inconsistencies. Postman also validates responses when you send a request from the collection. - [Import an API into the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/importing-an-api/): You can import an existing API specification into the Postman API Builder. API specifications can be imported from a local file or directory, a URL, raw text, or an API gateway. - [Share and collaborate on APIs in the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/managing-apis/): When you [define your APIs](/docs/design-apis/api-builder/overview/) in Postman using the API Builder, each API is associated with a workspace. You can share access to your APIs, discuss them in comments, and view schema activity. #### Observe an API - [View Datadog APM metrics in the Postman API Builder](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. The API Builder has a Datadog integration that enables you to access Datadog APM metrics from within Postman. - [View APM metrics and monitor APIs in the Postman API Builder](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. The API Builder has a New Relic integration that enables you to access New Relic APM metrics from within Postman. - [View APM metrics in the Postman API Builder](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, and share monitor results. - [Develop APIs with the API Builder in Postman](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](https://www.postman.com/api-platform/api-lifecycle/) to your API definition, such as collections, documentation, and tests. You can also [integrate your API](/docs/design-apis/api-builder/versioning-an-api/overview/) in Postman with a Git repository, such as GitHub, GitLab, Bitbucket, or Azure DevOps. - [Add automated tests and CI integrations in the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/testing-an-api/): [Testing](https://www.postman.com/api-platform/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. You can also integrate your API with supported continuous integration (CI) tools. #### API version control - [Publish a version of your API for consumers in the Postman API Builder](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_. Publishing a version creates a static representation of your API's current state. Consumers can view the API version in your workspace. You can also choose to add the version to your [Private API Network](/docs/collaborating-in-postman/private-api-network/overview/). - [Manage multiple APIs in the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/connecting-multiple-apis/): You can 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. For complete steps, see [Connect to a cloud-hosted Git repository](/docs/design-apis/api-builder/versioning-an-api/using-cloud-git-repo/) or [Connect to an on-premises Git repository](/docs/design-apis/api-builder/versioning-an-api/using-on-prem-git-repo/). - [Push and pull changes in the Postman API Builder](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. Any changes you make to your API definition or collections always happen on a branch. You can work on any branch in your repository. - [Manage changes with Git in the Postman API Builder](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](/docs/administration/managing-your-team/create-teams/) to connect to a remote repository. GitHub Enterprise Server, GitLab Self-Managed, and Azure DevOps Server (hosted on-premises) integrations are available with Postman Enterprise plans with the API Builder add-on. [Learn more about what's included with each plan](https://www.postman.com/pricing/). - [Connect to a cloud-hosted Git repository in the Postman API Builder](https://learning.postman.com/docs/design-apis/api-builder/versioning-an-api/using-cloud-git-repo/): You can connect your API to a cloud-hosted Git repository to sync your API definition and collections between Postman and the repository. Postman supports connecting to [GitHub](https://github.com/), [Bitbucket](https://bitbucket.org/), [GitLab SaaS](https://about.gitlab.com/), or [Azure DevOps](https://azure.microsoft.com/en-us/products/devops/) repositories. - [Connect to an on-premises Git repository in the Postman API Builder](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 API Builder add-on.](https://www.postman.com/pricing/)** ### Postman Collections - [Add types to body data with an API collection](https://learning.postman.com/docs/design-apis/collections/add-properties-to-body-data/): You can add [body data](/docs/sending-requests/create-requests/parameters/#send-body-data-with-requests) to your API requests to send a data payload along with the request. You can also add a response body to [saved request examples](/docs/sending-requests/response-data/examples/) to show valid responses for different use cases. Generate a schema from the raw (JSON) body for a request or from the response body for a saved example. Then add more details to the schema using types, like a default value or description. Details appear in the [collection's documentation](/docs/design-apis/collections/view-properties-and-documentation/#view-documentation-for-a-collection-with-types). - [Add types to parameters and headers with an API collection](https://learning.postman.com/docs/design-apis/collections/add-properties-to-parameters-and-headers/): You can add types to [parameters](/docs/sending-requests/create-requests/parameters/) and [headers](/docs/sending-requests/create-requests/headers/#configure-request-headers). Types can include data type, format, default value, and possible values. You can also specify if a component is required. Details you add will appear in the [collection's documentation](/docs/design-apis/collections/view-properties-and-documentation/#view-documentation-for-a-collection-with-types). - [Generate an API specification from your collection](https://learning.postman.com/docs/design-apis/collections/generate-specifications/): You can [generate an OpenAPI 3.0 specification from a collection](#generate-openapi-specifications-from-a-collection) in [Spec Hub](/docs/design-apis/specifications/overview/). Generated specifications enable you to complete the API lifecycle by integrating your API with downstream systems, such as API gateways or security scanners. You can also [keep the specification in sync](#keep-openapi-specifications-in-sync-with-a-collection) with its collection. - [Design your APIs with Postman 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. Define types such as data type, format, and possible values. You can also specify if a component is required. Before you send a request, Postman checks it using the defined types and identifies possible issues. All the details appear in the collection's documentation for both API developers and consumers. - [View types and documentation for an API collection](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](/docs/publishing-your-api/viewing-documentation/#viewing-documentation-for-a-collection). ### Mock an API - [Generate dynamic mock server responses with variables](https://learning.postman.com/docs/design-apis/mock-apis/create-dynamic-responses/): Postman [mock servers](/docs/design-apis/mock-apis/set-up-mock-servers/) return static responses defined in [saved examples](/docs/sending-requests/response-data/examples/). To return responses that use random data, or that vary based on the request, you can generate dynamic responses. With dynamic mock responses, you can simulate various scenarios without having to create a saved example for each one. - [How a Postman mock server matches requests to saved examples](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. When you call it using its URL (for example, `https://M1.mock.pstmn.io`), the mock service retrieves all saved examples (responses) for the associated collection before it begins the matching process. - [Make calls to mock servers](https://learning.postman.com/docs/design-apis/mock-apis/mock-server-calls/): After [setting up a mock server](/docs/design-apis/mock-apis/set-up-mock-servers/), you can begin making calls to its URL. When you send a request to a mock server, the mock server sends back a response based on an example with the same path and method. [You can provide multiple examples](/docs/design-apis/mock-apis/tutorials/mock-with-examples/), and Postman returns the one that [best matches your request](/docs/design-apis/mock-apis/matching-algorithm/). - [Simulate your API in Postman with a mock server](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. When you send a request, Postman returns a real-world response using data from your collection. - [Set up a Postman mock server](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. A mock server simulates a real API server by accepting requests and returning responses. By configuring a mock server for your [collection](/docs/sending-requests/create-requests/intro-to-collections/) and adding [examples](/docs/sending-requests/response-data/examples/) to your requests, you can simulate the behavior of a real API. #### Mock server tutorials - [Create and use a mock server using the Postman API](https://learning.postman.com/docs/design-apis/mock-apis/tutorials/mock-with-api/): Set up a [mock server](/docs/design-apis/mock-apis/set-up-mock-servers/) to simulate the behavior of a real API for development or testing purposes. In Postman, you [mock a collection](/docs/design-apis/mock-apis/tutorials/mock-with-examples/) by adding examples and creating a mock server. You can automate the process of setting up a mock server using the [Postman API](https://api.postman.com/). - [Mock APIs with response examples](https://learning.postman.com/docs/design-apis/mock-apis/tutorials/mock-with-examples/): [Mock servers](/docs/design-apis/mock-apis/set-up-mock-servers/) simulate an API server by returning predefined data, so you can develop or test an API before it's ready for production. In Postman, mock servers use [examples](/docs/sending-requests/response-data/examples/) saved in an HTTP collection to return mock data. - [Learn how to use mock servers with 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. You'll learn how to use examples to set up custom responses and how to create mock servers using the [Postman API](https://api.postman.com). This makes it easier to test your API and can help you automate your workflow during development. - [Design and build your APIs in Postman](https://learning.postman.com/docs/design-apis/overview/): Postman offers a variety of ways to [design and develop your APIs](https://www.postman.com/api-platform/api-lifecycle/). Use Postman Collections to add types to your HTTP requests that define parameters, headers, and body data. You can define your API's structure with Spec Hub in an API specification, and generate a collection from the specification to share with your consumers. Use the API Builder to define your API's structure in an API definition, linking Postman elements that help you design and test your API. You can also create a mock server that simulates your API's requests and responses before it's production ready. ### Design APIs with specifications - [Manage a multi-file API specification](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. Multi-file specifications are supported for OpenAPI 2.0, 3.0, and 3.1 specifications. - [Create a new API specification](https://learning.postman.com/docs/design-apis/specifications/create-a-specification/): [Create a specification](#create-a-new-specification) in Spec Hub to design and test your API's structure. You can create a specification in OpenAPI 2.0, 3.0, or 3.1 format or in AsyncAPI 2.0 format. Then you can [share your specification with collaborators](#share-a-specification). - [Edit your API specification](https://learning.postman.com/docs/design-apis/specifications/edit-a-specification/): Edit your specification to update the structure and design of your API. [Navigate your specification](#navigate-your-specification) using the outline in the sidebar and [the command palette](#navigate-using-the-command-palette) to find and jump to specific sections. You can [add new sections using snippets](#add-new-sections-using-snippets) to add pre-formatted blocks that you can fill out. You can [generate a schema from a JSON request or response body](#generate-a-schema-from-a-json-body), and add the schema directly to your specification. You can also organize your OpenAPI 2.0, 3.0, or 3.1 specification into [multiple files and folders](#add-files-and-folders). - [Generate collections from your API specification](https://learning.postman.com/docs/design-apis/specifications/generate-collections/): You can [generate a collection from a specification](#generate-collections-from-a-specification) to share it with your team members and consumers. With the generated collection, they can test your API or explore its capabilities. You can also [keep a collection in sync](#keep-collections-in-sync-with-an-openapi-specification) with its specification if it was generated from an OpenAPI 3.0 specification. - [Import an API specification](https://learning.postman.com/docs/design-apis/specifications/import-a-specification/): You can import an existing OpenAPI 2.0, 3.0, or 3.1 specifications or AsyncAPI 2.0 specifications in Spec Hub. Import a single or multi-file OpenAPI 2.0, 3.0, or 3.1 specification as a collection or a specification and collection. Import an AsyncAPI 2.0 specification as a specification in Spec Hub only. - [Design API specifications in Postman](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 2.0, 3.0, or 3.1 specifications or AsyncAPI 2.0 specifications, and you can import existing OpenAPI and AsyncAPI specifications into Spec Hub. Navigate using the outline view, and add new sections with snippets. Tools such as autocomplete, syntax checking, and live documentation preview help you as you work. - [Validate an API specification](https://learning.postman.com/docs/design-apis/specifications/validate-a-specification/): As you [edit your specification](/docs/design-apis/specifications/edit-a-specification/), Postman identifies [syntax errors](#view-syntax-errors-in-your-specification), such as wrong data types and nesting, and shows details about the errors so you can correct them. Postman also identifies [API governance issues](#view-rule-violations-in-your-specification) in OpenAPI 2.0, 3.0, and 3.1 specifications, based on the rules configured for your team. - [View live documentation for your API specification](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 2.0, 3.0, or 3.1 specification or AsyncAPI 2.0 specification. The documentation preview is updated as you edit the specification. You can use the preview to help you visualize your changes as you work. - [Sync collections and specifications reference](https://learning.postman.com/docs/design-apis/sync-specifications-reference/): The following are frequently asked questions about Postman's [Spec Hub](/docs/design-apis/specifications/overview/) feature. Use these questions to learn about different behavior when generating and syncing between collections and specifications in Spec Hub. ## Developer resources - [Generate client code for your API collections](https://learning.postman.com/docs/developer/code-generators/): You can generate client code for your API collections in Postman. Postman's Node.js code generator module converts a request into client code for your target language in conjunction with the [Collection SDK](/docs/developer/collection-sdk/). - [Convert API formats into Postman Collections](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](https://learning.postman.com/collection-format/getting-started/overview/). Each convertor is available as a [Node.js](https://nodejs.org/en/about) module that you can automate in your continuous integration and continuous deployment (CI/CD) pipeline. - [Create and manage collections using 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](/docs/sending-requests/create-requests/intro-to-collections/) and build them dynamically into your API project pipeline. - [Test requests in Postman using the Echo API](https://learning.postman.com/docs/developer/echo-api/): You can use the Postman Echo service to test requests in Postman. The Echo service returns a JSON response that includes all details from the request you sent, including any data items you included. ### Postman API reference - [Generate and use Postman API keys](https://learning.postman.com/docs/developer/postman-api/authentication/): The Postman API and [Postman CLI](/docs/postman-cli/postman-cli-overview/) use API keys for authentication. A Postman API key tells the server that the request came from you. You can use API keys to manage and access various resources and elements you create in Postman, which enables you to integrate Postman into your development toolchain. - [Integrate Postman into your development toolchain](https://learning.postman.com/docs/developer/postman-api/intro-api/): Use the [Postman API](https://api.postman.com/) to programmatically manage your Postman assets and integrate Postman into your development toolchain. You can manage collections, environments, monitors, and other Postman elements. You can also access data stored in your Postman account and combine the Postman API with the [Postman CLI](/docs/postman-cli/postman-cli-overview/) or [Newman](/docs/collections/using-newman-cli/continuous-integration/) to integrate Postman with your CI/CD workflow. - [Access Postman data programmatically](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. You can use the API to perform actions such as managing your collections, APIs, workspaces, and more. - [Track Postman API call 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. #### Postman MCP Server - [Use AI agents with the Postman API](https://learning.postman.com/docs/developer/postman-api/postman-mcp-server/overview/): The [Postman Model Context Protocol (MCP) server](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7) enables AI agents like Claude, Cursor, and VS Code to help you manage your Postman resources, including [workspaces](/docs/collaborating-in-postman/using-workspaces/overview/), [collections](/docs/collections/use-collections/use-collections-overview/), [specifications](/docs/design-apis/specifications/overview/), [mocks](/docs/design-apis/mock-apis/overview/), and [monitors](/docs/monitoring-your-api/intro-monitors/). The server translates your natural language commands into API workflows behind the scenes. With [MCP](https://modelcontextprotocol.io/introduction), you can build AI agents and complex workflows on top of LLMs using the tools and context provided by the servers. - [Tips and best practices for using the Postman MCP server](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. You can request complex workflows and API interactions, and let the AI take care of the heavy lifting. This document covers some useful tips for working with agents and prompts you can use to get started with the Postman MCP server. - [Set up the Postman MCP 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](#remote-server) through streamable HTTP and [local servers](#local-server) with STDIO. The remote server is available at `https://mcp.postman.com/` and `https://mcp.eu.postman.com` for the EU, and the local server is available in the [Postman MCP Server GitHub repository](https://github.com/postmanlabs/postman-mcp-server). You can also [fork the Postman MCP collection](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7) from the Postman Public Workspace. - [Postman developer resources](https://learning.postman.com/docs/developer/resources-intro/): You can use a variety of Postman developer resources in your projects, including APIs and libraries. You can use and contribute to Postman's [open-source](https://www.postman.com/open-philosophy/) projects on [GitHub](https://github.com/postmanlabs). - [Configure request and collection runs using the Postman Runtime library](https://learning.postman.com/docs/developer/runtime-library/): The Postman Runtime library is an [open-source Node.js project](https://github.com/postmanlabs/postman-runtime/) you can use for low-level configuration over request sending in your API development and testing projects. It supports request sending and [collection running](/docs/collections/running-collections/intro-to-collection-runs/) in Postman and other interfaces including the [Postman CLI](/docs/postman-cli/postman-cli-overview/) or [Newman](/docs/collections/using-newman-cli/command-line-integration-with-newman/). ### Postman VS Code extension - [Add and manage CA and client certificates in the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/certificates/): You can 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. You won't need to turn off SSL verification in your request. You can also add a client certificate to connect to an API that uses Mutual TLS (mTLS) authentication. - [Document your APIs from the Postman VS Code extension](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 languages. Using the built-in editor, you can add a description, include links, and add images and videos. By including documentation in your collections, it provides more context and detail, making it more useful to users. - [Give feedback about the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/feedback/): Share your feedback to help improve the Postman VS Code extension. #### Import data - [Import environment variables using the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/import-data/import-environment-variables/): You can [import `.env` files with environment variables](#import-environment-variables) from your API project into new environments in Postman. Then you can [sync changes](#sync-environment-variables) from your `.env` files to their respective environments in Postman. This enables you to maintain your environment variables in your API project and sync them with your environments in Postman when you're ready to test your APIs. - [Import Postman data using the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/import-data/import-postman-data/): You can import collections and environments that were [exported from Postman](/docs/getting-started/importing-and-exporting/exporting-data/). You can also import requests using a cURL command. - [Import data using the Postman 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. You can also import and sync environment variables from your API project's `.env` files. - [Install the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/install/): To get started with Postman in VS Code, choose the [supported application](#application-requirements) where you'd like to install the Postman VS Code extension. Then complete the [pre-requisite configurations](#prerequisites) required to use the VS Code extension. Once complete, [install the VS Code extension](#install), then [sign in](#sign-in-to-postman) to Postman. - [Create and manage environments from the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/manage-environments/): You can 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. Environments make it easier to change variables based on your work context, such as sending requests to a test or production server. When you switch between environments, all variables in your requests and scripts use the current environment's values. - [Develop APIs with the Postman VS Code extension](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](https://code.visualstudio.com/) and other supported applications. You can use the VS Code extension to send API requests, manage collection and environments, troubleshoot requests, and much more. Streamline your development workflow by testing your APIs in the same application you use to develop them. - [Use AI agents with the Postman API from the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/postman-mcp-server/): With the Postman VS Code extension, you can integrate the [Postman Model Context Protocol (MCP) server](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7) with your AI agent in VS Code. This enables you to manage your Postman resources, like [workspaces](/docs/collaborating-in-postman/using-workspaces/overview/) and [collections](/docs/collections/use-collections/use-collections-overview/), with your agent using the Postman API. This integration uses the [streamable HTTP Postman MCP server](/docs/developer/postman-api/postman-mcp-server/set-up-postman-mcp-server/#remote-server) with the minimal tool configuration mode, which includes only essential tools for basic Postman operations. - [Send API requests from the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/send-requests/): The Postman VS Code extension enables you to create and send [HTTP](#send-http-api-requests) and [multi-protocol](#send-multi-protocol-api-requests) requests, or your [request history](#send-api-requests-from-your-history). Use the Postman Console in the VS Code extension to [debug and troubleshoot](#troubleshoot-with-the-postman-console) issues with your requests. It also supports [creating code snippets](#generate-code-snippets) from your API requests for various languages, such as Node.js or cURL. You can also use [cookies](#use-cookies) with the VS Code extension. - [Share your work from the Postman VS Code extension](https://learning.postman.com/docs/developer/vs-code-extension/share/): You can collaborate in Postman with the Postman VS Code extension by sharing your collections, environments, and workspaces with your team. You can assign collection and environment roles to specific users or groups, create and send invite links. You can also control access permissions for shared elements, and invite users as collaborators. #### Tests and scripts - [Use the Collection Runner from the Postman VS Code extension](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. This enables you to test an API's functionality or performance. You can also automate collection runs in your CI/CD with the [Postman CLI](/docs/postman-cli/postman-cli-overview/) or [Newman](/docs/collections/using-newman-cli/command-line-integration-with-newman/). - [Test APIs using the Postman VS Code extension](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. You can also manually run your collections and access to your API's test results. - [Reuse packages from the Postman VS Code extension](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 [Postman Package Library](#reuse-scripts-with-the-package-library) into scripts in your internal workspaces. You can also import packages from [external packages registries](#import-packages-from-external-registries), such and npm or JSR, into your scripts. - [Test APIs using the Postman VS Code extension](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. You can add pre-request and [post-response scripts](#test-your-api-using-scripts) to your HTTP collections, folders, and requests. You can also [open pre-request and post-response scripts as a JavaScript file](#edit-scripts-as-a-javascript-file), giving you the full editing experience of your code editor. - [Create and manage collections from the Postman VS Code extension](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. You can also manage your existing collections and make changes to them directly in VS Code. ## Get started ### Your Postman account - [Manage your Postman account](https://learning.postman.com/docs/getting-started/account/manage/): [Signing up](/docs/getting-started/first-steps/sign-up-for-postman/) for a Postman account enables you to begin collaborating with others from the outset. On paid plans, you can find [discoverable teams](/docs/collaborating-in-postman/use-teams/#find-teams-within-your-organization) you can join. Or you can continue building your free team, which you automatically get on sign-up. If you have more than one Postman account, you can [link to](#link-your-account-to-postman) and [switch](#switch-between-accounts) between your accounts. - [About Postman accounts](https://learning.postman.com/docs/getting-started/account/overview/): With a free Postman account, you can access your work from different machines and [collaborate](/docs/collaborating-in-postman/collaborate-in-postman-overview/) with others on your API projects. - [Manage your Postman account settings](https://learning.postman.com/docs/getting-started/account/settings/): You can manage account settings, including two-factor authentication, your email address, password, and workspace data on your [account settings](https://go.postman.co/settings/me/account/) page. ### Postman basics - [About Agent Mode](https://learning.postman.com/docs/getting-started/basics/about-agent-mode/): Postman Agent Mode is available on Free, Basic, and Professional plans to users who consent to using AI. - [About Postbot](https://learning.postman.com/docs/getting-started/basics/about-postbot/): Postbot add-on is available in [Enterprise plans](https://www.postman.com/pricing/) with a limited number of activities per user each month. If you purchased Postbot on a Free, Basic, or Professional plans before December 1, it'll continue to work for you. Learn more about [resource usage in Postman](/docs/billing/resource-usage/). - [About the Postman 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](/docs/getting-started/installation/installation-and-updates/#use-the-postman-web-app). The Postman Agent is required to bypass the cross-origin resource sharing (CORS) limitations of web browsers. Postman has four agents you can select from. - [Navigating Postman](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. This guide is a high-level overview of Postman's primary interface areas: - [Postman basics overview](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, and use Postman in your API development workflows. You'll also get a tour of the Postman user interface to launch you on your API-first journey. - [About Postman elements](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](https://www.postman.com/api-platform/api-lifecycle/). Learn more about integral parts of Postman like collections and environments. - [Sync your changes across devices](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. As long as you're signed in to Postman, and have an internet connection, your data will sync. - [Build and send requests offline using the lightweight Postman 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. When you aren't signed in to Postman, you can still use the lightweight [API Client](https://www.postman.com/api-platform/api-client/) to build and send HTTP, WebSocket, gRPC, and GraphQL requests. To use the lightweight Postman API Client, [install the Postman desktop app](/docs/getting-started/installation/installation-and-updates/). - [Build and send requests offline using 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. When you aren't signed in or don't have a network connection, you can still access some Postman features offline, such as creating collections and requests, or sending requests. All your work in the Scratch Pad is stored locally and isn't synced online with Postman. After working in the Scratch Pad, you can later move your work into a workspace once you sign in. ### Postman first steps - [Create your first collection](https://learning.postman.com/docs/getting-started/first-steps/creating-the-first-collection/): To create a new [collection](/docs/getting-started/basics/postman-elements/#collections), in this example, you'll start by creating a new request first. You can create a new request from the sidebar in Postman. - [Discover public APIs on the Postman API Network](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. Developers can use the API Network to explore APIs, contribute to them, and publish their own. Many of the companies you know and love publish their APIs to a public workspace on the Postman API Network. - [Get the Postman app](https://learning.postman.com/docs/getting-started/first-steps/get-postman/): **[Download the Postman app for macOS, Windows, or Linux.](https://www.postman.com/downloads/)** - [Take your next steps in Postman](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. Check out some other things you can do in Postman: - [Your first steps with Postman](https://learning.postman.com/docs/getting-started/first-steps/overview/): Follow this quick guide to get started using Postman. You'll learn how to install the Postman app, send an API request, write your first test, and save requests in a collection. You'll also learn about working with your team in Postman and discovering APIs on the Postman API Network. - [Send your first 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](/docs/getting-started/basics/postman-elements/#requests), including HTTP, GraphQL, and gRPC requests. Using Postman, you can send a request to an endpoint, retrieve data from a data source, or test an API's functionality. You don't need to enter commands in a terminal or write any code. When you create a new request and click **Send**, the API response returns directly in Postman. - [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](/docs/getting-started/first-steps/get-postman/). - [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. For example, you might write a test to validate your API's error handling by sending a request with incomplete data or wrong parameters. You can write tests for your Postman API requests in JavaScript and add them to individual [requests](/docs/sending-requests/create-requests/create-requests/), [collections](/docs/sending-requests/create-requests/intro-to-collections/), and folders in a collection. Postman includes code snippets you can add and then change to suit your test logic. ### Import and export data - [Export data from Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/): You can export your Postman data, including collections, environments, global variables, and data dumps, as JSON files. You can import these files back into any Postman instance, share them with others, or use them with the [Postman CLI](/docs/postman-cli/postman-cli-overview/) or [Newman](/docs/collections/using-newman-cli/command-line-integration-with-newman/). - [Data import and export in Postman](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. Postman can also import non-Postman data, such as API definitions and data from other API clients, to help you unify your API development workflow. - [Import cURL commands](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-curl-commands/): [cURL](https://curl.se/) is a popular command-line tool for making HTTP requests. When testing a web application or API, cURL enables you to interact directly from the command line, using a well-established syntax that's common in the API developer community. If you have several cURL commands in different places, you can import them into Postman. - [Import data into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data/): You can import collections, API definitions, and other data files so you can work with them in Postman. - [Import data from a Git repository](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-git/): If you have [API definitions](/docs/design-apis/api-builder/develop-apis/defining-an-api/), [API specifications](/docs/design-apis/specifications/overview/), [collections](/docs/collections/use-collections/use-collections-overview/), or [environments](/docs/sending-requests/variables/managing-environments/) in a Git repository, you can import the data so you can work with it in Postman. - [Import 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. - [Import 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. - [Import data from New Relic](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](https://www.postman.com/pricing/).** You can [create a free account](https://identity.getpostman.com/signup) and then [create a new team](/docs/administration/managing-your-team/create-teams/) to try out this feature. [Let us know what you think](https://github.com/postmanlabs/postman-app-support/issues). - [Import from SoapUI](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-soapui/): [SoapUI](https://www.soapui.org/) is an API testing tool that supports SOAP and REST services. Postman can import SoapUI project files and recreate their requests, collections, environments, and other data in your Postman workspace. - [Import Swagger APIs](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](/docs/design-apis/api-builder/importing-an-api/#supported-api-specifications-formats). - [Import 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. Postman can import collection and environment files exported from Thunder Client. ### Install and configure - [Postman installation overview](https://learning.postman.com/docs/getting-started/installation/install-overview/): Postman provides several installation options and enables you to customize your user experience. With a free Postman account, you can securely access your APIs from different machines and collaborate with others on API design. To scale up your API lifecycle, take advantage of paid Postman plans. You can also set up a proxy server as another security barrier. - [Install and update Postman](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](https://www.postman.com/downloads/) and select the option for your operating system. Postman is available as a native desktop app for Windows (Intel 64-bit or ARM 64-bit), macOS (Intel or Apple silicon), and Linux (Intel 64-bit or ARM 64-bit). - [Customize your Postman profile](https://learning.postman.com/docs/getting-started/installation/postman-profile/): Once you create your Postman account, you can customize [your Postman profile](https://go.postman.co/me) and share about yourself and your best work. - [Configure Postman to use a proxy server](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 an API). The proxy server acts as a security barrier, making requests on your behalf to websites and other internet resources, and preventing others from accessing your internal network. - [Customize Postman settings](https://learning.postman.com/docs/getting-started/installation/settings/): Postman automatically chooses default values for some settings so you can get right to work. Make changes to settings at any time based on your use case or to customize your Postman experience. - [Postman system requirements](https://learning.postman.com/docs/getting-started/installation/system-requirements/): The following are the system requirements for the Postman desktop app on [Windows](#windows), [Mac](#mac), and [Linux](#linux) operating systems. If your operating system doesn't meet these requirements, you may be unable to install Postman on your device. - [Get started in Postman](https://learning.postman.com/docs/getting-started/overview/): Welcome! This section of the Postman Docs contains topics about how to get started using Postman. ### Try Postman Enterprise - [Postman Enterprise+ FAQs](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. - [Try Postman Enterprise features](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. It includes premium Enterprise features, unlimited team invites, and access to select add-ons, designed to help teams work better together across the entire API lifecycle. ## Postman Insights - [Customize your Postman Insights](https://learning.postman.com/docs/insights/customize/): The Postman Insights Agent observes your API traffic to automatically populate your endpoints inside your _Insights project_. You can customize your project to pinpoint, monitor, and troubleshoot the endpoints you're most interested in. ### Data handling - [Data access and handling](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 considerations](https://learning.postman.com/docs/insights/data/daemonset-security/): DaemonSet (multi-namespace) uses the Kubernetes API and the [Container Runtime Interface (CRI)](https://kubernetes.io/docs/concepts/architecture/cri/) to obtain information on the running pods and containers. This includes environment variables, which may contain authentication credentials or other secrets. If the Postman Insights Agent is compromised, these values can be exfiltrated. - [Postman Insights data access and storage](https://learning.postman.com/docs/insights/data/overview/): Postman Insights practices responsible data access and storage. This means that the Postman Insights Agent does not access or store more data than it needs to perform its function. - [Repro mode data redactions](https://learning.postman.com/docs/insights/data/redactions/): Postman Insights treats handling of user data seriously. This page describes the set of default fields and values that Postman Insights redacts, replacing with `*REDACTED*`, to help ensure compliance with security and privacy requirements. - [Repro Mode security considerations](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. This information is stored in the Postman Cloud and shown to any user with the Viewer access to the Postman Insights project. - [Debug with Insights](https://learning.postman.com/docs/insights/debug/): Repro Mode aims to make it seamless to rerun requests using real user data from production. The Insights Agent prefills the data for you from the observed traffic, eliminating the need to check logs and traces to find the elements needed to send the request and fix your failing endpoint. - [Frequently asked questions about Postman Insights](https://learning.postman.com/docs/insights/faq/): The following are some frequently asked questions you might have about Postman Insights. ### Get started with Flows - [Install Postman Insights Agent on AWS Elastic Beanstalk](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 endpoints. - [Try a local Insights demo](https://learning.postman.com/docs/insights/get-started/demo/): You can 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](https://www.docker.com/get-started/). - [Install Postman Insights Agent on EC2](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. - [Install Postman Insights Agent on AWS ECS](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 endpoints. #### Kubernetes - [Install Postman Insights Agent as a DaemonSet](https://learning.postman.com/docs/insights/get-started/kubernetes/daemonset/): Install the Postman Insights Agent as a [DaemonSet](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) if you want to install it in multiple services at once, for example, across your entire organization by your DevOps or platform team. - [Install Postman Insights Agent on Kubernetes](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 endpoints. - [Install Postman Insights Agent as a sidecar](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](https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/). To reproduce errors on real user data, activate the Insights' Repro Mode. - [Get started with Postman Insights](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. Within minutes, the AI algorithms will discover your endpoints, and you’ll be able to monitor errors across your endpoints. - [About Postman Insights](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. If you would like to try Postman Insights on an Enterprise plan, please [email the Postman Insights team](mailto:observability-support@postman.com). ### Flows reference #### Insights agent - [apidump command reference](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](#examples). For help, use `-h` or `--help`. - [completion command reference](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. See each sub-command's help for details on how to use the generated script. - [ecs add command reference](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](#examples). For help, use `-h` or `--help`. - [ecs cf-fragment command reference](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. For help, use `-h` or `--help`. - [ecs task-def command reference](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 EC2 instance in the cluster. For help, use `-h` or `--help`. - [kube helm-fragment command reference](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 container. - [kube inject command reference](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](#examples). - [kube run command reference](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 Linux images only). - [kube secret command reference](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. - [kube helm-fragment command reference](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 `kubernetes_deployment` resource spec to add the Postman Insights Agent as a sidecar container. - [apidump command reference](https://learning.postman.com/docs/insights/reference/agent/overview/): Explore the different commands to use with the Postman Insights Agent. #### Insights app - [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. With Insights alerts you can adjust error rate thresholds, find and view problematic endpoints, hide or display alerts globally for specific endpoints, and integrate your alerts with Slack. - [Insights Diagnostics](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. Visit this page if you're not sure if the Insights Agent is connected, or if you want to check that the agent is seeing all of your traffic. You can also install new agents from this tab. - [Insights 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. Check that you're receiving the endpoints you expect, and give hints to the algorithm on API endpoint discovery. - [Insights Errors tab](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, to make it easier to help you find and fix errors. Thanks to AI-powered endpoint discovery, the **Errors** page shows aggregate per-endpoint error data. - [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. - [Insights 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. It filters for HTTP methods, hosts, path templates, and search queries. You can also sort the results by endpoint name, latency percentile, or request count. - [Insights Overview](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. This displays information such as **Total requests observed**, **P90 Latency**, **Errors**, and **Endpoint health**. - [Postman Insights interface](https://learning.postman.com/docs/insights/reference/app/overview/): Explore the different options, graphs, and settings in the Postman Insights app. - [Insights Settings](https://learning.postman.com/docs/insights/reference/app/settings-tab/): In the **Settings** tab, you can [activate Repro Mode](#activate-repro-mode), control [what data gets redacted](#fields-to-redact) in Repro Mode, and control whether dashboards [show IP host and health check](#show-ip-hosts-and-health-checks) endpoints. - [Postman Insights reference](https://learning.postman.com/docs/insights/reference/overview/): Learn about different Postman Insights features and functions. ### Troubleshoot - [ECS memory issues](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. Consider specifying an upper limit. Learn more from the following use cases. - [Diagnose and troubleshoot Insights errors](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. As you work in Insights, you may encounter errors and receive error messages. In many of these cases, there's a solution. - [Troubleshoot traffic issues](https://learning.postman.com/docs/insights/troubleshoot/traffic/): You've set up the Postman Insights Agent, and you've been running API traffic across the network, but your API model page is either empty or shows random endpoints you don't care about. - [Uninstall the Postman Insights Agent](https://learning.postman.com/docs/insights/uninstall/): If you need to remove the Postman Insights Agent from your local machine and deployment, follow the [CLI](#cli) instructions and the directions listed for your deployment: [Kubernetes](#kubernetes), [AWS ECS](#aws-ecs), [AWS EC2](#aws-ec2), and [AWS Elastic Beanstalk](#aws-elastic-beanstalk). You can also contact [Support](#support). ## Amazon API Gateway ### Amazon API Gateway #### Apigee - [Deploy to Apigee from the Postman API Builder](https://learning.postman.com/docs/integrations/available-integrations/apigee-api-management/deploying-an-api-apigee/): [Apigee X](https://cloud.google.com/apigee) enables developers to manage access to their APIs by abstracting services behind a secure proxy layer. Once connected to Apigee, you can view your API deployment status and history from within Postman. - [Integrate Postman with APIMatic](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, and then periodically backs up the resulting file on GitHub. #### Amazon API Gateway - [Deploy to Amazon API Gateway from the Postman API Builder](https://learning.postman.com/docs/integrations/available-integrations/aws-api-gateway/deploying-an-api-aws/): [Amazon API Gateway](https://aws.amazon.com/api-gateway/) enables developers to publish and manage APIs that access AWS and other web services and data sources. Once connected to API Gateway, you can view your API deployment status and history from within Postman. You can also view [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) metrics for each stage to get operational insight into your API. - [Integrate Postman with 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.** After you connect your API to API Gateway, you can view stage information and deployment history on the **Deployments** tab in the API Builder. #### Azure API Management - [Deploy to Azure API Management from the Postman API Builder](https://learning.postman.com/docs/integrations/available-integrations/azure-api-management/deploying-an-api-azure/): [Azure API Management](https://azure.microsoft.com/en-us/services/api-management/) enables developers to deploy API gateways for APIs hosted in Microsoft Azure, other cloud platforms, or on-premises. Once connected to Azure API Management, you can view your API deployment status and history from within Postman. You can also export your OpenAPI definition from Postman to Azure API Management, or import a definition from Azure to use it in Postman. - [Integrate Postman 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.](https://www.postman.com/pricing/)** - [Integrate Postman with BigPanda](https://learning.postman.com/docs/integrations/available-integrations/bigpanda/): [BigPanda](https://www.bigpanda.io/) is an IT systems management platform that aggregates and correlates IT alerts to create high-level IT incidents. It directs all alerts to a single place with different connected services. - [Integrate Postman with Bitbucket](https://learning.postman.com/docs/integrations/available-integrations/bitbucket/): You can back up your Postman Collections to your Bitbucket repository. Once the integration is configured, any changes to your collection in Postman also appear in your Bitbucket repository. #### CI integrations - [Integrate Postman with Azure Pipelines](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). - [Integrate Postman with Bitbucket Pipelines](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/bitbucket-pipelines/): [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines) is a continuous integration and continuous delivery (CI/CD) service that's integrated with Bitbucket Cloud. Software development teams can use Bitbucket Pipelines to automatically build, test, and deploy code in Bitbucket. - [Integrate Postman with CircleCI](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/circleci/): CircleCI is a cloud-based continuous integration and continuous delivery (CI/CD) platform. Software development teams use CircleCI to run build jobs, automate tests, and orchestrate complex workflows. - [Integrate GitHub Actions with Postman](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.](https://www.postman.com/pricing/)** - [Integrate Postman with GitLab CI/CD](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.](https://www.postman.com/pricing/)** - [Integrate Postman with Jenkins](https://learning.postman.com/docs/integrations/available-integrations/ci-integrations/jenkins/): [Jenkins](https://www.jenkins.io/) is an open source automation server that can act as a continuous integration (CI) server or a continuous delivery (CD) hub. With hundreds of available plug-ins, teams can use Jenkins to build, deploy, and automate almost any project. - [Integrate Postman with Travis CI](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. With Travis CI, developers can get immediate feedback on the success of a change. - [Integrate Postman with Coralogix](https://learning.postman.com/docs/integrations/available-integrations/coralogix/): [Coralogix](https://coralogix.com/) is a machine-learning-powered log analytics platform which improves the delivery and maintenance process for software providers. This integration enables you to configure your Postman Monitors to send metrics to Coralogix where you can visualize and compare metrics. - [Integrate Postman with Datadog](https://learning.postman.com/docs/integrations/available-integrations/datadog/): [Datadog](https://www.datadoghq.com/) is a monitoring service for cloud-scale applications. It combines data from servers, databases, tools, and services to present a unified view of an entire stack. This integration enables you to configure your [Postman Monitors](/docs/monitoring-your-api/intro-monitors/) to send metrics to Datadog, where you can visualize and compare them with other metrics. - [Integrate Postman with Dropbox](https://learning.postman.com/docs/integrations/available-integrations/dropbox/): Back up and synchronize your Postman Collections on Dropbox for file sharing, storage, and collaboration. The Postman to Dropbox integration complements your existing workflows and enables you to store your collections and other project files in one place. #### GitHub - [Back up your collections to GitHub](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.](https://www.postman.com/pricing/)** ##### Postman Collections - [Collaborate with your team on your collection](https://learning.postman.com/docs/integrations/available-integrations/github/collections/collaborate/): Once you [connect your GitHub repository and primary branch to your collection](/docs/integrations/available-integrations/github/collections/connect/#connect-a-github-repository-and-branch-to-your-collection), you can fork your collection and collaborate with your team on it. - [Connect a GitHub repository 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. For example, connect your repository's primary branch to your collection, [fork that collection in Postman](/docs/integrations/available-integrations/github/collections/collaborate/#fork-a-collection-connected-to-your-github-repository-and-branch), and [collaborate with your team on your collection's next release](/docs/integrations/available-integrations/github/collections/collaborate/#collaborate-on-your-collection). - [Collaborate on your collections with GitHub](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. - [Integrate GitHub with Postman](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. You can also back up your collections or sync your APIs with GitHub. - [Integrate Postman with GitLab](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.](https://www.postman.com/pricing/)** #### Jira - [Connect your Jira account to Postman](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 collection, collection run, or response in Postman](/docs/integrations/available-integrations/jira/create-issue/). You can switch Jira accounts at any time. - [Create a Jira issue from Postman](https://learning.postman.com/docs/integrations/available-integrations/jira/create-issue/): Once you [connect your Jira account to your Postman account](/docs/integrations/available-integrations/jira/connect/), you can create a new Jira issue from an HTTP collection, collection run, or response in Postman. You can also link to an existing issue. - [Integrate Jira with Postman](https://learning.postman.com/docs/integrations/available-integrations/jira/overview/): Connect your Jira Cloud account to Postman and streamline your Jira and Postman workflows. Once you connect your account, you can create new Jira issues or link to existing ones directly from a collection, collection run, or response. For example, if a 200 OK response is too slow, you can create a Jira issue from the response in Postman. Similarly, you can create issues for common errors, such as 404 Not Found and 500 Internal Server Error. - [View your Jira issues from Postman](https://learning.postman.com/docs/integrations/available-integrations/jira/view-issues/): You can view all open Jira issues linked to your collections and requests to track your project's status or assess your API's performance. You can also open these issues in Jira. - [Integrate Postman with Keen](https://learning.postman.com/docs/integrations/available-integrations/keen/): You can use Keen for API-based computation, Amazon S3 backups, and building visualizations and dashboards for your APIs. Connect your Postman Monitor results to Keen Streams with the Postman Keen integration. - [Integrate Postman with Microsoft Power Automate](https://learning.postman.com/docs/integrations/available-integrations/microsoft-power-automate/): [Microsoft Power Automate](https://www.microsoft.com/en-us/power-platform/products/power-automate) enables you to automate workflows between your favorite apps and services to get notifications, synchronize files, collect data, and more. It offers over 140 services with predefined flows that you can implement. - [Integrate Postman with Microsoft 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](https://go.pstmn.io/integrations-teams) to get started. - [Integrate Postman with New Relic](https://learning.postman.com/docs/integrations/available-integrations/new-relic/): [New Relic](https://newrelic.com/) is an application performance management solution to monitor real-time and trending data for your processes or web apps. Using Postman's [New Relic integration](https://newrelic.com/instant-observability/postman?utm_source=external_partners&utm_medium=referral&utm_campaign=global-ever-green-io-partner), you can send [Postman Monitor](/docs/monitoring-your-api/intro-monitors/) results to New Relic. - [Integrate Postman with Opsgenie](https://learning.postman.com/docs/integrations/available-integrations/opsgenie/): [Opsgenie](https://www.atlassian.com/software/opsgenie) is an incident management and alerting tool that enables you to manage alerts. It has several communication features such as SMS, phone calls, and mobile push notifications, and collaboration features such as escalations and schedules. - [Integrate Postman with PagerDuty](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, and automatic escalation of critical incidents. - [Postman-built integrations](https://learning.postman.com/docs/integrations/available-integrations/postman-integrations/): With [Postman integrations](https://www.postman.com/product/integrations/), you can connect Postman to the tools you use in your API development workflow. Sync your collections and APIs to a source code repository, send alerts to your team messaging app, view API build and deployment information in Postman, and more. #### Slack - [Personal notification types](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. - [View Postman team activity in Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-activity/): Your team's [activity feed](/docs/collaborating-in-postman/using-workspaces/internal-workspaces/use-workspaces/#view-workspace-activity) keeps you up to date on what your team is working on. You can integrate Postman with Slack to automatically send team updates to a channel in Slack. You can get notified about team activity such as changes to workspaces, collections, and other Postman elements. - [Connect your Postman account to 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](https://go.pstmn.io/Integrations-page-slack) in the Slack App Directory to get started. - [Send Postman Monitor results to Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-monitoring/): [Postman Monitors](/docs/monitoring-your-api/intro-monitors/) enable you to continuously check the health and performance of your APIs. You can integrate Postman with Slack to automatically send monitor results to a channel in Slack. Each time the monitor runs, you'll get a notification in Slack with the results. It's recommended that you set up Slack notifications when you configure a monitor. Alternatively, you can set up Slack notifications when you set up a Postman Monitor integration. - [Get personal notifications in Slack](https://learning.postman.com/docs/integrations/available-integrations/slack/slack-notifications/): [Notifications](/docs/getting-started/account/settings/#update-your-notification-preferences) keep you up to date on what's happening in Postman. In addition to in-app and email notifications, you can get Postman notifications and alerts in Slack. Once you connect your Postman account to Slack, you can customize the types of notifications you'll receive. - [Integrate Postman with 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](https://go.pstmn.io/Integrations-page-slack/) in the Slack App Directory to get started. - [Integrate Postman with Splunk On-Call](https://learning.postman.com/docs/integrations/available-integrations/splunk-on-call/): [Splunk On-Call](https://www.splunk.com/en_us/products/on-call.html) (formerly VictorOps) is a real-time incident management platform that handles incidents as they occur and prepares for the next one. - [Integrate Postman with Splunk](https://learning.postman.com/docs/integrations/available-integrations/splunk/): Splunk is a monitoring service for cloud-scale applications. It combines data from servers, databases, tools, and services to present a unified view of an entire stack. This integration enables you to configure your Postman Monitors to send metrics to Splunk where you can visualize and compare them with other metrics. - [Integrate Postman with Statuspage](https://learning.postman.com/docs/integrations/available-integrations/statuspage/): Atlassian's [Statuspage](https://www.atlassian.com/software/statuspage) is an uptime and incident communication tool. You can use Statuspage to create a home page for your customers so they can monitor if subsystems or services within your site are operational. Customers can also use the home page to find out more information on system outages or failures. An example of a Statuspage home page is Postman's status page, located at [status.postman.com](https://status.postman.com). #### Postman app for Teams - [Send Postman Monitor notifications to your Microsoft Teams channels](https://learning.postman.com/docs/integrations/available-integrations/teams/team-notifications/): You can set up [Postman Monitors](/docs/monitoring-your-api/intro-monitors/) to automatically send monitor results to a Microsoft Teams channel or group chat. Each time the monitor runs, you'll get notified in Teams. Alternatively, you can create a Microsoft Teams workflow to connect your monitors to your Teams channels. When Postman runs your monitor, you'll get notified in the Teams channel of your choice. - [Connect your Postman account to Microsoft 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](https://go.pstmn.io/integrations-teams) to get started. - [Integrate Postman with OpenAPI](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/): You can import your existing OpenAPI 3.0 and 3.1 definitions ([OpenAPI Specification](https://spec.openapis.org/oas/latest.html)) into Postman. Postman supports both YAML and JSON formats. Spec Hub supports OpenAPI 3.0, and the Postman API Builder supports OpenAPI 3.0 and 3.1. - [Integrate CI tools in Postman](https://learning.postman.com/docs/integrations/ci-integrations/): Continuous integration and continuous delivery (CI/CD) are a core part of the [API development workflow](/docs/design-apis/api-builder/overview/). Postman integrates with popular CI tools so you can view details about API builds in the same place where you define and test your API. CI integrations support APIs in the [Postman API Builder](/docs/design-apis/api-builder/overview/). - [Add new integrations using installed apps in Postman](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. _Installed apps_ streamline this process by enabling all members of a team to use the same stored authorization details when adding an integration. - [Integrate Postman with third-party solutions](https://learning.postman.com/docs/integrations/intro-integrations/): You can connect Postman to your API workflows with integrations for popular third-party solutions. Integrations enable you to automatically share data between Postman and the other tools you rely on for API development, such as GitHub, Slack, CircleCI, AWS API Gateway, and New Relic. - [Configure custom webhooks in Postman](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, collect data, and more. It offers services with predefined workflows that you can implement. ## Introduction - [Give feedback about Postman](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. To submit feedback, you can post in the [community forum](https://community.postman.com/) or send your feedback directly to [Postman's docs team](mailto:docs-feedback@postman.com). - [Postman documentation overview](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. - [Resources about APIs and Postman](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. Build your knowledge and skills with [training collections](#training-collections), [collection templates](#collection-templates), and [Quick Help](#quick-help) in the Postman app or learn about the [API Lifecycle](https://www.postman.com/api-platform/api-lifecycle/). For instructor-led workshops, self-paced modules, and certifications, visit [Postman Academy](#postman-academy). Stay informed about new features and improvements with the [release notes page](#release-notes). - [Troubleshoot issues with the Postman app](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. ## Monitor collections - [Postman Monitors frequently asked questions](https://learning.postman.com/docs/monitoring-your-api/faqs-monitors/): Following are frequently asked questions about configuring, running, updating, securing, and troubleshooting Postman Monitors. - [Monitor health and performance of your APIs in Postman](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/): _Postman Monitors_ enable you to [continuously check the health and performance of your APIs](https://www.postman.com/api-platform/api-observability/). You can create monitors that run requests in selected collections. Requests can run API test scripts, chain together multiple requests, and more. You can also schedule how often Postman runs monitored collections. - [Manage monitor usage in Postman](https://learning.postman.com/docs/monitoring-your-api/monitor-usage/): Postman provides tools to help you manage your team's monitor usage. Track the number of monitoring requests that have been made against your plan's monthly usage limit, and enable overages or purchase more blocks if needed. You can also view all of the monitors your team has created to make sure you're not exceeding monitor activity limits. ### Monitor internal APIs - [Configure runners for internal APIs](https://learning.postman.com/docs/monitoring-your-api/runners/configure-a-runner/): Private API Monitoring is available with [Postman Basic, Professional, and Enterprise plans](https://www.postman.com/pricing/). To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager. - [Manage runners for internal APIs](https://learning.postman.com/docs/monitoring-your-api/runners/manage-runners/): Private API Monitoring is available with [Postman Basic, Professional, and Enterprise plans](https://www.postman.com/pricing/). To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager. - [Monitor internal APIs with runners](https://learning.postman.com/docs/monitoring-your-api/runners/overview/): Private API Monitoring is available with [Postman Basic, Professional, and Enterprise plans](https://www.postman.com/pricing/). To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager. - [Set up a runner to use a proxy server](https://learning.postman.com/docs/monitoring-your-api/runners/runners-proxy-server/): Private API Monitoring is available with [Postman Basic, Professional, and Enterprise plans](https://www.postman.com/pricing/). To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager. - [Set up a runner in your restricted network](https://learning.postman.com/docs/monitoring-your-api/runners/set-up-a-runner-in-your-network/): Private API Monitoring is available with [Postman Basic, Professional, and Enterprise plans](https://www.postman.com/pricing/). To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager. - [Troubleshoot runners in Postman](https://learning.postman.com/docs/monitoring-your-api/runners/troubleshoot-runners/): Private API Monitoring is available with [Postman Basic, Professional, and Enterprise plans](https://www.postman.com/pricing/). To enable Private API Monitoring in your Enterprise team, contact your Postman Customer Success Manager. - [Set up a monitor in Postman](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. When creating a monitor, you select a collection with the requests you want to run and set a schedule for how often Postman runs the collection. - [Troubleshoot monitors in Postman](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. - [Configure Postman Monitors to run from static IPs](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.](https://www.postman.com/pricing/)** - [View monitor results](https://learning.postman.com/docs/monitoring-your-api/viewing-monitor-results/): [Monitors](/docs/monitoring-your-api/setting-up-monitor/) continuously track the health and performance of your APIs. With Postman, you can stay up to date on what's happening across all monitors in your workspace. Or you can review individual monitors to examine test results and performance over time. ## Postman AI ### Create AI request blocks - [Create an AI request block for your flow](https://learning.postman.com/docs/postman-ai/ai-request-blocks/create/): You use [**AI Request**](/docs/postman-flows/reference/blocks/ai-request/) blocks to interact with AI models, which can help you evaluate different models, add AI to your workflows, prototype AI agents, and much more. You can add **AI Request** blocks to [flow modules](/docs/postman-flows/get-started/build-your-first-flow/) and [actions](/docs/postman-flows/build-flows/structure/actions/). - [Use your AI request block to interact with an AI model](https://learning.postman.com/docs/postman-ai/ai-request-blocks/interact/): When you [create an AI request block](/docs/postman-ai/ai-request-blocks/create/), you select an AI request for it. You can use the AI request to control how your AI request block interacts with the model in your flow. - [Create AI request blocks and add them to your flows](https://learning.postman.com/docs/postman-ai/ai-request-blocks/overview/): You create AI request blocks to interact with an AI model of your choice, such as one from [OpenAI](https://platform.openai.com/docs/), [Google](https://ai.google.dev/gemini-api/docs/), or [Anthropic](https://docs.anthropic.com/). You can then manage how you interact with the model. ### Send requests to AI models - [Add an MCP server to your AI request](https://learning.postman.com/docs/postman-ai/ai-requests/add-mcp-servers/): You add [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) servers to your AI requests to give the AI models you interact with further context. For example, you can add the [Postman MCP Server](https://www.postman.com/getmcp/workspace/public-mcp-servers/collection/682c95c75ac051812a618a18?action=share&creator=19201670) to your request and then prompt the model to create a Postman Collection for you. - [Create an AI request for your collection](https://learning.postman.com/docs/postman-ai/ai-requests/create/): You create AI requests to interact with AI models. You can choose any OpenAI-compatible model, whether it's from [OpenAI](https://platform.openai.com/docs/), [Anthropic](https://docs.anthropic.com/), [Google](https://ai.google.dev/gemini-api/docs), or an alternative provider such as [HuggingFace](https://huggingface.co). Use your requests to experiment, test, and evaluate different AI models, including fine-tuned, self-hosted, and local ones. Choose the model that best fits your security requirements, budget, and workflow. - [Use your AI request to interact with an AI model](https://learning.postman.com/docs/postman-ai/ai-requests/interact/): You interact with AI models with two kinds of prompts: user prompts and system prompts. - [Manage how you interact with an AI model](https://learning.postman.com/docs/postman-ai/ai-requests/manage/): You can edit your AI request authorization details and adjust the settings that influence how you interact with the model. - [Create AI requests and add them to your collections](https://learning.postman.com/docs/postman-ai/ai-requests/overview/): You create AI requests to interact with an AI model of your choice. Choose any OpenAI-compatible model, whether it's from [OpenAI](https://platform.openai.com/docs/), [Anthropic](https://docs.anthropic.com/), [Google](https://ai.google.dev/gemini-api/docs), or an alternative provider such as [HuggingFace](https://huggingface.co). Use AI requests to experiment, test, and evaluate different AI models, whether they're fine-tuned, self-hosted, or local. Use the model that best fits your security requirements, budget, and workflow. ### Send requests to MCP servers - [Create an MCP request for your collection](https://learning.postman.com/docs/postman-ai/mcp-requests/create/): You create [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) requests to interact with MCP servers. You can use these requests to experiment, test, and evaluate different MCP servers, such as [one from the community](https://www.postman.com/explore/mcp-servers) or one you built yourself. - [Add an MCP server to your MCP host](https://learning.postman.com/docs/postman-ai/mcp-requests/export-mcp-server-config/): You can add an MCP server to Postman Agent Mode to give it further context and extend its capabilities. - [Use your MCP request to interact with an MCP server](https://learning.postman.com/docs/postman-ai/mcp-requests/interact/): You can interact with [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) servers with server and client capabilities. These features give AI models further context and extend their capabilities. - [Manage how you interact with an MCP server](https://learning.postman.com/docs/postman-ai/mcp-requests/manage/): You can edit your [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) request authorization details and adjust the settings that influence how you interact with the server. - [Create MCP requests and add them to your collections](https://learning.postman.com/docs/postman-ai/mcp-requests/overview/): You create [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) requests to interact with an MCP server of your choice, such as [one from the community](https://www.postman.com/explore/mcp-servers) or one you built yourself. Postman can also [generate an MCP server for you](/docs/postman-ai/mcp-servers/overview/). Use MCP requests to experiment, test, and evaluate different MCP servers. ### Create MCP servers with Flows - [Create an MCP server with Postman Flows](https://learning.postman.com/docs/postman-ai/mcp-server-flows/create-mcp-server-flow/): In [Postman Flows](/docs/postman-flows/overview/), you can define a special [_scenario_](/docs/postman-flows/build-flows/configure/scenarios/) to create an [_Action_](/docs/postman-flows/build-flows/structure/actions/) that functions as a [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) server with MCP [tools](https://modelcontextprotocol.io/docs/concepts/tools), [prompts](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts), and [resources](https://modelcontextprotocol.io/specification/2025-06-18/server/resources). Once deployed, the [action](/docs/postman-flows/build-flows/structure/actions/)’s URL can receive requests, process incoming data using [blocks](/docs/postman-flows/reference/blocks/overview/), and send responses. - [MCP servers in Postman Flows](https://learning.postman.com/docs/postman-ai/mcp-server-flows/mcp-server-flows/): In [Postman Flows](/docs/postman-flows/overview/), you can define a special [_scenario_](/docs/postman-flows/build-flows/configure/scenarios/) to create an [_Action_](/docs/postman-flows/build-flows/structure/actions/) that functions as a [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) server with MCP [tools](https://modelcontextprotocol.io/docs/concepts/tools), [prompts](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts), and [resources](https://modelcontextprotocol.io/specification/2025-06-18/server/resources). When deployed to a public URL, the action can process incoming requests and send the results as responses. - [Create MCP servers with Postman Flows](https://learning.postman.com/docs/postman-ai/mcp-server-flows/overview/): You can create [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) servers and MCP [tools](https://modelcontextprotocol.io/docs/concepts/tools), [prompts](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts), and [resources](https://modelcontextprotocol.io/specification/2025-06-18/server/resources) using [_actions_](/docs/postman-flows/build-flows/structure/actions/) in Postman Flows. Actions are flows running in the cloud, with public URLs where users can send requests. The action processes the requests and returns the results that the AI model generates using the MCP server's tools. You can create and run an MCP server as an action without doing any coding. ### Generate MCP servers - [Generate an MCP server with public APIs from the Postman API Network](https://learning.postman.com/docs/postman-ai/mcp-servers/generate/): With Postman's [MCP Generator](https://www.postman.com/explore/mcp-generator), you choose public API requests from the Postman API Network, and Postman generates a [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server for you. For each request, Postman creates a [tool](https://modelcontextprotocol.io/docs/concepts/tools). The server supports the MCP [standard input and output](https://modelcontextprotocol.io/docs/concepts/transports#standard-input%2Foutput-stdio) (STDIO) and [streamable HTTP](https://modelcontextprotocol.io/docs/concepts/transports#streamable-http) transport layers. - [Use Postman to interact with your generated MCP server and an AI model](https://learning.postman.com/docs/postman-ai/mcp-servers/interact/): You can use Postman to interact with your generated MCP server locally and an AI model of your choice. - [Create MCP servers with the Postman API Network](https://learning.postman.com/docs/postman-ai/mcp-servers/overview/): With Postman's [MCP Generator](https://www.postman.com/explore/mcp-generator), you can create a [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server with public APIs from the Postman API Network. Then, you can use Postman to experiment, test, and evaluate your MCP server and an AI model of your choice. - [Promote your MCP server on the Postman API Network](https://learning.postman.com/docs/postman-ai/mcp-servers/promote/): The [Postman API Network](https://www.postman.com/explore/) is where millions of developers discover, test, and integrate APIs. Publishing your work on the Postman API Network is a powerful way to get new customers and drive deeper adoption from your existing user base. As the industry shifts towards AI-driven applications, developers are actively seeking new ways for agents and models to interact programmatically with services. - [Set up and start your generated MCP server locally](https://learning.postman.com/docs/postman-ai/mcp-servers/set-up-start/): For each request you add to your [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server, Postman generates a [tool](https://modelcontextprotocol.io/docs/concepts/tools) for you. Once you set up your server and start it, you can [use Postman to interact with it](/docs/postman-ai/mcp-servers/interact/). The server supports the MCP [standard input and output](https://modelcontextprotocol.io/docs/concepts/transports#standard-input%2Foutput-stdio) (STDIO) and [streamable HTTP](https://modelcontextprotocol.io/docs/concepts/transports#streamable-http) transport layers. - [About Postman AI features](https://learning.postman.com/docs/postman-ai/overview/): Postman's AI features enable you to perform tasks faster, automate your workflows, and build your own AI models. ## Explore the Postman API Network ### Explore the Postman API Network - [Consume public APIs from the Postman API Network](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. You can then fork their elements to your own workspace and use them there. Remember to watch elements to get notified when there's a change. #### Find public APIs - [Browse public APIs on the Postman API Network](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, and see what's popular among the Postman community. As you browse the Postman API Network, watch, fork, and copy the Postman elements that pique your interests. - [Find public APIs on the Postman API Network](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 public APIs on the Postman API Network](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. As you explore Postman and the Postman API Network, Postman adds your recent views and searches to search. You can also ask Postbot to create and find requests. - [Explore public APIs on the Postman API Network](https://learning.postman.com/docs/postman-api-network/explore/overview/): The [Postman API Network](https://www.postman.com/explore/) is the world's largest network of public APIs. As an API consumer, you can explore the API Network and find a public API for your next project. Many of the companies you know and love publish their APIs to a public workspace on the Postman API Network ### Publish to the Postman API Network - [Analyze developer engagement across your public APIs](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, and your publisher profile, from discovery to adoption. You can view user activity over the last 6-month period by weeks or months. It’s your hub for insights into API visibility, usability, and engagement. - [Explore your publisher tools on the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/explore-publisher-tools/): You can access your public profile, workspaces, analytics, and team settings from the [Postman API Network's landing page](https://www.postman.com/explore/). You can also create a public workspace and Run in Postman button from the same page. - [Showcase your public APIs on the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/overview/): Introduce your public APIs to over 40 million users from around the globe. To start your API publisher journey, you'll use Postman to collaborate and curate your publisher team, workspace, and collections for the Postman API Network. #### Prepare your public APIs ##### Curate your public collections - [Curate your public collections for the Postman API Network](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. Introduce your public APIs, communicate their capabilities, and create a great developer experience. - [Curate your public collection's developer experience for the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/public-collections-developer-experience/): You can curate your public collection's developer experience for your API consumers by setting up authentication and authorization, variables and environments, and scripts and tests. - [Curate your public collection's overview for the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/public-collections-overview/): You can curate your collection's overview to introduce your public APIs to your API consumers. A well-curated collection invites your API consumers to [fork](/docs/collaborating-in-postman/using-version-control/forking-elements/) and use your APIs—and gets them to their first 200 OK response in the fewest steps as possible. - [Curate your public collection's requests for the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/prepare/curate/public-collections-requests/): You can curate your collection's requests to communicate your public API's capabilities to your API consumers. A well-curated collection invites your API consumers to [fork](/docs/collaborating-in-postman/using-version-control/forking-elements/) and use your APIs—and gets them to their first 200 OK response in the fewest steps as possible. - [Prepare your public APIs for the Postman API Network](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. When you're ready to [publish your APIs](/docs/postman-api-network/showcase/publish/overview/), you'll [make your workspace a public](/docs/postman-api-network/showcase/publish/public-apis/#make-your-workspace-public), and give API consumers access to your public APIs. - [Prepare your public collections for the Postman API Network](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. When you [publish your public APIs](/docs/postman-api-network/showcase/publish/public-apis/), you can invite your API consumers to [fork your public collections](/docs/collaborating-in-postman/using-version-control/forking-elements/), and get them to their first 200 OK response fast. - [Prepare your public workspace for the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/prepare/public-workspace/): Your public workspace is a landing page for your public APIs. It's where API consumers find your public APIs, learn about them, and can [fork your public collections to their own workspace](/docs/collaborating-in-postman/using-version-control/forking-elements/), where they can start using them. - [Prepare your internal workspace for team collaboration](https://learning.postman.com/docs/postman-api-network/showcase/prepare/team-workspace/): You can use an internal workspace to draft and organize your work, and [collaborate with your team](/docs/collaborating-in-postman/collaborate-in-postman-overview/). To prepare your internal workspace, you'll fork [your public collections](/docs/postman-api-network/showcase/prepare/public-collections/) from [your public workspace](/docs/postman-api-network/showcase/prepare/public-workspace/) to your internal workspace. - [Become a verified publisher on the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/prepare/verify-publisher-team/): Being a verified publisher is the best way to build trust with developers on Postman. Verify your profile and earn Postman's trusted badge of verification Verified badge icon. Verified publishers rank higher in search results and are recommended across the Postman API Platform, helping developers easily recognize your API as the official source. #### Publish your public APIs - [Maintain your public APIs for the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/publish/maintain-public-apis/): If you [prepared a team workspace for team collaboration](/docs/postman-api-network/showcase/prepare/team-workspace/), you can draft your next release there. Otherwise, you can update your changes in place in your public workspace. ##### Publish interactive articles - [Create a notebook for the Postman API Network](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. Or create a notebook to document one of your public API's most popular use cases. Collaborate with your team to bring together your best ideas. ###### Draft interactive articles - [Add script runner blocks to your notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/add-code-runner-blocks/): You can write JavaScript code and reference its output elsewhere in your notebook to create an interactive experience. For example, you can add a script runner block that generates a random number and use that number in a [request block](/docs/postman-api-network/showcase/publish/notebooks/draft/add-request-blocks/) that accepts one. You can also [import external libraries](/docs/tests-and-scripts/write-scripts/packages/external-package-registries/) and [visualize your data](/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-visualizer/). - [Add input blocks to your notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/add-input-blocks/): You can add variables and reference them elsewhere in your notebook to create an interactive experience. For example, you can add an input block for your API consumer's email address and [use a request block](/docs/postman-api-network/showcase/publish/notebooks/draft/add-request-blocks/) to send them a welcome message. - [Add request blocks to your notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/add-request-blocks/): You can add API requests and reference their responses elsewhere in your notebook to create an interactive experience. For example, you can [add an input block](/docs/postman-api-network/showcase/publish/notebooks/draft/add-input-blocks/) for your API consumer's email address and use a request block to send them a welcome message. - [Format content and add media to your notebook](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/draft/format/): You can format your notebook with text and block styles. Use text styles to bold, italicize, underline, and strike through text. Use block styles to format headings, lists, quotes, and code snippet blocks. You can also add videos from YouTube, Vimeo, and Loom to your notebooks. - [Draft your notebook for your API consumers](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. - [Showcase your public APIs with Postman Notebooks](https://learning.postman.com/docs/postman-api-network/showcase/publish/notebooks/overview/): With *Postman Notebooks*, you showcase your public APIs with interactive articles. Document your workflows and share an interactive experience with your API consumers, where they send requests to your public APIs in real time. Notebooks combine your documentation, code, and APIs in one place, where you guide your API consumers to their first 200 OK response. - [Publish your notebook to the Postman API Network](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. Guide them to their first 200 OK response with your hands-on, real-world examples, and showcase your public API to the world. - [Publish your public APIs to the Postman API Network](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. Maintain them and give your API consumers access to your API's latest changes. - [Publish your public APIs to the Postman API Network](https://learning.postman.com/docs/postman-api-network/showcase/publish/public-apis/): Once you've [prepared your public workspace](/docs/postman-api-network/showcase/prepare/public-workspace/), [prepared your public collections](/docs/postman-api-network/showcase/prepare/public-collections/), [curated them](/docs/postman-api-network/showcase/prepare/curate/overview/), and [prepared your team workspace for team collaboration](/docs/postman-api-network/showcase/prepare/team-workspace/), you're ready to publish your public APIs. ## Postman CLI - [Install the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-installation/): Install the [Postman CLI](/docs/postman-cli/postman-cli-overview/) by following the instructions for your operating system below. - [Postman CLI command options](https://learning.postman.com/docs/postman-cli/postman-cli-options/): This topic covers the commands and options supported by the [Postman CLI](/docs/postman-cli/postman-cli-overview/). - [Explore Postman's command-line companion](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. The Postman CLI supports the following features: - [Generate collection run reports using the Postman CLI](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](/docs/postman-cli/postman-cli-run-collection/). The following reporters are available: CLI, JSON, JUnit, and HTML. You can use more than one reporter for a run, and you can customize the report output to meet your needs. - [Run a collection using the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-collection/): You can use the [Postman CLI](/docs/postman-cli/postman-cli-overview/) to manually run collections to test the functionality of your API. You can also use the Postman CLI to automate collection runs in CI/CD pipelines. - [Run a monitor using the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-monitor/): Monitors enable you to regularly check the health and performance of your APIs. You can use the [Postman CLI](/docs/postman-cli/postman-cli-overview/) to trigger [monitor runs](/docs/monitoring-your-api/intro-monitors/) within your CI/CD pipeline. Then your team can use your Postman tests to automatically catch regressions and configuration issues during your deployment process. Depending on whether the monitor run passes or fails, you can push or roll back your changes. ## Postman Flows ### Build flows #### Analyze - [Check deployed action health and run history](https://learning.postman.com/docs/postman-flows/build-flows/analyze/analytics/): The **Analytics** tab in Postman Flows provides details about how your deployed actions run in the Postman Cloud. Use the **Analytics** tab to monitor when, how often, and how long your actions run, and whether they succeed or fail. In the displayed run logs, you can open any individual block and view its success/failure status, data input and output, and further details. - [Demo your flows with slides](https://learning.postman.com/docs/postman-flows/build-flows/analyze/slides/): You can create on-canvas demos and tutorials for your flows with _slides_. Slides in Postman Flows enable you to create slide-deck presentations that focus on specific areas and blocks in your flow. These presentations provide an effective way to show and explain your flows to colleagues and other flows users. - [Visualize data in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/analyze/visualize-data/): The **Display** block accepts information from other blocks and creates a visualization of that information. You can select from several visualization types. #### Configure - [Configure values for actions in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/configure/configure-values-actions/): When you create an action, you'll often want to include static values for its blocks to use. This includes both parameters used in HTTP requests and variables used in other kinds of blocks. - [Create Postman requests and variables using Postman Flow blocks](https://learning.postman.com/docs/postman-flows/build-flows/configure/requests-and-variables/): You can send API requests and receive responses in your flows with the **HTTP Request** block. Your flow can then evaluate and transform the response data to inform its logic, make decisions, and pass relevant information to other blocks. - [Assign input values with scenarios](https://learning.postman.com/docs/postman-flows/build-flows/configure/scenarios/): _Scenarios_ are sets of values assigned to [**Start**](/docs/postman-flows/reference/blocks/start/) block inputs. You can define multiple scenarios with different values for inputs, and change between scenarios for different use cases. For example, scenarios are convenient when you're testing flow modules or actions that require the same inputs but different values for each test. They're also useful when you want to use different input values for a beta or production deployment. - [Version flows with snapshots](https://learning.postman.com/docs/postman-flows/build-flows/configure/snapshots/): _Snapshots_ enable you to save, view, and restore versions of your flows. With snapshots, you can create and manage reliable versions of your flows to share with others. You can also experiment with design ideas without fear of breaking a functioning flow. #### Create - [Create copies of flows with clones](https://learning.postman.com/docs/postman-flows/build-flows/create/clone-flows/): You can create copies of flows with the _clone_ feature in Postman Flows. When you clone a flow, the cloned flow includes all the requests and modules present in the original flow. You can clone a flow into the same workspace as the original or into a different workspace. When you clone a flow into a new workspace, any requests used by the flow are copied into a new collection in that workspace. - [Create blocks in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/create/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. You can find an explanation and example for every block in [Blocks overview](/docs/postman-flows/reference/blocks/overview/). - [Connect blocks in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/create/create-connections/): Blocks communicate with each other through connections. Connections are like unidirectional conduits that carry data between blocks. Most blocks have an input port, an output port, or both, where connections can begin or end. Many blocks' output ports can have multiple connections so you can send their data to more than one block. You can select and drag a block's output port to create and connect to a new block. #### Connect - [Connect third-party services to Flows actions](https://learning.postman.com/docs/postman-flows/build-flows/flows-connectors/flows-connectors/): You can connect third-party services to Flows with **Connector** blocks. Once connected, your Flow can interact with the service through predefined tasks called *operations*. #### Organize - [Organize flows with color, annotations, and groups](https://learning.postman.com/docs/postman-flows/build-flows/organize/organize-flows/): As you build more flows and their designs become more complex, the ability to organize your flows becomes more important. Flows have several features that enable organization on the canvas and folders to assist with organizing flows in the sidebar. - [Share links to flows and embed flows in websites](https://learning.postman.com/docs/postman-flows/build-flows/organize/share-and-embed-flows/): You can share flows by sending links or embedding iframes in websites and other online resources. This enables colleagues and anyone with internet access to see your flows on public websites, internal wikis, and online documentation. By sharing flows both inside and outside the Postman API platform, you can foster development, streamline testing, and effectively promote your APIs. - [Build flows overview](https://learning.postman.com/docs/postman-flows/build-flows/overview/): Postman Flows lets you automate and visualize API workflows using modular building blocks. This guide introduces you to creating, connecting, and testing flows using [flow modules](/docs/postman-flows/get-started/build-your-first-flow/) and [actions](/docs/postman-flows/build-flows/structure/actions/). #### Structure - [Send URL-encoded or form data to actions in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/structure/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. This topic explains how to create scenarios for **Request** blocks in actions whose HTTP request bodies need to be formatted as `form-data` or `x-www-form-urlencoded` data. For actions whose request bodies will only require plain JSON, skip this topic and follow the [Request block setup instruction](/docs/postman-flows/reference/blocks/request/#setup) instead. - [Deploy flows as actions in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/structure/actions/): An _action_ is a flow that's deployed in the Postman cloud. Unlike [_flow modules_](/docs/postman-flows/get-started/build-your-first-flow/), which must be run manually, actions can be scheduled, or triggered by external systems like third-party services, other APIs, or webhooks. Actions are useful for running automations and exposing functionality as an API or as an AI tool for MCP servers. - [Work with date and time formats in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/structure/date-and-time/): Many APIs expect different formats for date and time. Flows has many built-in [Flows Query Language (FQL)](/docs/postman-flows/flows-query-language/introduction-to-fql/) and TypeScript functions to handle any of the formats required. - [Find and filter data in Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/structure/find-and-filter-data/): Frequently, the need arises to check if information in a flow has a certain value. Depending on the structure of the information returned from an API, there are several different ways to solve this using [Flows Query Language (FQL)](/docs/postman-flows/flows-query-language/introduction-to-fql/). ##### Structure - [Loops with external data](https://learning.postman.com/docs/postman-flows/build-flows/structure/loops/loops-external-data/): The [Loops Overview](/docs/postman-flows/build-flows/structure/loops/overview/) showed how to build loops that begin with a **For** or **Repeat** block, then send each iteration's output through a sequence of blocks to a **Collect** block. The blocks in those examples were all _inside the loop_. In this topic, you'll learn how to rigorously define what it means for a block to be _inside the loop_ or _outside the loop_. This matters because data that originates outside the loop behaves differently than data that originates inside. - [Loops for pagination](https://learning.postman.com/docs/postman-flows/build-flows/structure/loops/loops-pagination/): You can use Postman Flows to build a "while do" loop that's well-suited to pagination use cases. - [Loops for polling](https://learning.postman.com/docs/postman-flows/build-flows/structure/loops/loops-polling/): You can use Postman Flows to build a "while do" loop that polls an API for new values until a condition is satisfied. - [Loops overview](https://learning.postman.com/docs/postman-flows/build-flows/structure/loops/overview/): Loops are a basic element of control flow in computer programming that Postman Flows supports. As a _visual_ programming environment, Flows has its own design patterns that you need to know to make looping structures work for you. #### Troubleshoot - [Troubleshoot Postman Flows](https://learning.postman.com/docs/postman-flows/build-flows/troubleshoot/troubleshoot/): Whether you're developing an application with code or building a flow with Postman Flows, sometimes things don't work as expected. *Troubleshooting* is the process of identifying the cause of the difference between what your flow is doing and what you expect it to do. Postman Flows includes several built-in tools to help with troubleshooting. - [Webhook migration guide](https://learning.postman.com/docs/postman-flows/build-flows/troubleshoot/webhook-migration-guide/): Webhooks will be sunset on Jan 15, 2026. Any existing flow modules that use webhooks will stop running after this date. You can preserve these modules' functionality by migrating them to [actions](/docs/postman-flows/reference/flows-actions-overview/), a more powerful, cloud-based alternative to webhooks. This guide shows how to migrate your workflows to actions. ### Flows cookbook - [Use the AI Agent block as logic for a flow](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. For example, you might get a response from an **HTTP Request** block and route the data to a **Select** block. The flow would process the selected data with an **Evaluate** block and send the result to a **Display** or **Output** block. This method can sometimes result in a complex system of blocks that perform your use case, but can be challenging to design and debug. - [Iterate through a list using a For loop](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. You can do this by constructing a loop with a **For** block. A **For** block requires an array as its input. Blocks such as **List**, **Get Variable**, **Evaluate**, and **Select** can return an array, but the response from an **HTTP Request** block typically doesn't. You can use TypeScript in an **Evaluate** block to transform a response into an array. - [Postman Flows Cookbook 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. The cookbook provides working examples of common tasks and shows prescribed methods for efficiently building your own flows. The focus of each recipe is to explain common idioms or design patterns that help you understand more advanced flow structures or design patterns involved in creating a flow. - [Persist data outside a flow](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. But you can design flows to persist data by sending it to an external data store, where you can retrieve it later. - [Select data from a complex JSON response](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. Understanding how to pull data from specific fields in a response is vital to designing effective flows. For example, you might want to extract an address field from several levels down in a complex JSON object from an API response. - [Use TypeScript in an Evaluate block](https://learning.postman.com/docs/postman-flows/cookbook/use-typescript-in-evaluate/): You can use TypeScript to process and manipulate data in [**Evaluate**](/docs/postman-flows/reference/blocks/evaluate/), [**Condition**](/docs/postman-flows/reference/blocks/condition/), and [**If**](/docs/postman-flows/reference/blocks/if/) blocks in your flows. For example, you might use TypeScript to format a timestamp, check a response for errors, or select an item from a list. ### Flows Query Language - [Use FQL conditional logic to select data](https://learning.postman.com/docs/postman-flows/flows-query-language/conditional-data-selection/): You can use [Flows Query Language](/docs/postman-flows/flows-query-language/introduction-to-fql/) (FQL) to filter for specific data in your responses. Multiple responses return in an array. Single responses return as a single record. Sample data and FQL examples are below. - [Manipulate data in FQL](https://learning.postman.com/docs/postman-flows/flows-query-language/data-manipulation/): You can use [Flows Query Language](/docs/postman-flows/flows-query-language/introduction-to-fql/) (FQL) to perform math functions, manipulate strings and arrays, and interact with the data in your responses. To help you get started with FQL, use the [sample data](#example-json) provided and FQL examples below. - [FQL function reference](https://learning.postman.com/docs/postman-flows/flows-query-language/function-reference/): All [Flows Query Language](/docs/postman-flows/flows-query-language/introduction-to-fql/) (FQL) functions are documented below. - [Get basic values in FQL](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. - [Introduction to Flows Query Language](https://learning.postman.com/docs/postman-flows/flows-query-language/introduction-to-fql/): You can use _Flows Query Language_ (FQL) to parse and transform JSON data to get the fields and structure you want. - [Return structured data in FQL](https://learning.postman.com/docs/postman-flows/flows-query-language/return-structured-results/): You can use [Flows Query Language](/docs/postman-flows/flows-query-language/introduction-to-fql/) (FQL) to transform one JSON object into another, differently structured, JSON object. This topic provides example FQL expressions that show different ways of structuring the JSON output of an **Evaluate** block in Postman Flows. ### Get started with Flows - [Build a "Hello, world" 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. With Postman Flows you can create *flow modules* that run locally, and [*actions*](/docs/postman-flows/build-flows/structure/actions/) that can be deployed in the Postman cloud. - [Explore ready-to-use Flows in the Postman Flows Catalog](https://learning.postman.com/docs/postman-flows/get-started/flows-catalog/): Flows Template Gallery is a collection of over 100 pre-built [flow modules](/docs/postman-flows/overview/) designed to address common use cases. Exploring Flows Template Gallery is a great way to learn what Postman Flows can do. - [Get familiar with the Postman Flows editor and canvas](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. This guide offers a high-level overview of the Postman Flows interface and its key elements. - [Get started with your Postman Flows API journey](https://learning.postman.com/docs/postman-flows/get-started/overview/): With Postman Flows, you can build API-first apps that automate tasks, integrate systems, and showcase your APIs to anyone in the world. You can get started with a new flow and learn by doing, or start creating with an existing flow from the Flows Template Gallery. - [Build API-first apps with Postman Flows—a visual, low-code editor](https://learning.postman.com/docs/postman-flows/overview/): You can use the *Postman Flows* low-code editor to prototype, build, and deploy [API-first](https://www.postman.com/api-first/) apps in a collaborative environment. Create [*flow modules*](#get-started-with-flows) that automate tasks, connect systems, and showcase your APIs to others on your team or the entire world with the [Postman API Network](/docs/collaborating-in-postman/public-api-network/public-api-network-overview/). You can also create and deploy special flows called [*actions*](/docs/postman-flows/build-flows/structure/actions/) that function as API endpoints on the Postman Cloud and can connect to third-party services. ### Flows reference #### Blocks - [The AI Agent block](https://learning.postman.com/docs/postman-flows/reference/blocks/ai-agent/): AI Agent block - [The AI Request block](https://learning.postman.com/docs/postman-flows/reference/blocks/ai-request/): AI Request block - [The Bool block](https://learning.postman.com/docs/postman-flows/reference/blocks/bool/): The Bool block - [The Collect block](https://learning.postman.com/docs/postman-flows/reference/blocks/collect/): The Collect block - [The Condition block](https://learning.postman.com/docs/postman-flows/reference/blocks/condition/): Condition block - [Connector blocks](https://learning.postman.com/docs/postman-flows/reference/blocks/connector/): Connector block - [The Create Variable block](https://learning.postman.com/docs/postman-flows/reference/blocks/create-variable/): Create Variable block - [The Create with AI block](https://learning.postman.com/docs/postman-flows/reference/blocks/create-with-ai/): The **Create with AI** block is a [beta feature](https://www.postman.com/legal/terms/). - [The Date & Time block](https://learning.postman.com/docs/postman-flows/reference/blocks/date-and-time/): The Date & Time block - [The Date block](https://learning.postman.com/docs/postman-flows/reference/blocks/date/): The Date block - [The Delay block](https://learning.postman.com/docs/postman-flows/reference/blocks/delay/): The Delay block - [The Evaluate block](https://learning.postman.com/docs/postman-flows/reference/blocks/evaluate/): Evaluate block - [The Flow Module block](https://learning.postman.com/docs/postman-flows/reference/blocks/flow-module/): Flow block - [The For block](https://learning.postman.com/docs/postman-flows/reference/blocks/for/): The For block - [The Get Configuration block](https://learning.postman.com/docs/postman-flows/reference/blocks/get-configuration/): Get Configuration block - [The Get Variable block](https://learning.postman.com/docs/postman-flows/reference/blocks/get-variable/): The Get Variable block - [The HTTP Request block](https://learning.postman.com/docs/postman-flows/reference/blocks/http-request/): The HTTP Request block - [The If block](https://learning.postman.com/docs/postman-flows/reference/blocks/if/): The If block - [The List block](https://learning.postman.com/docs/postman-flows/reference/blocks/list/): The List block - [The Log block](https://learning.postman.com/docs/postman-flows/reference/blocks/log/): The Log block - [The Now block](https://learning.postman.com/docs/postman-flows/reference/blocks/now/): The Now block - [The Null block](https://learning.postman.com/docs/postman-flows/reference/blocks/null/): The Null block - [The Number block](https://learning.postman.com/docs/postman-flows/reference/blocks/number/): The Number block - [The OR block](https://learning.postman.com/docs/postman-flows/reference/blocks/or/): OR block - [The Display block](https://learning.postman.com/docs/postman-flows/reference/blocks/output-display/): Display block - [The Output block](https://learning.postman.com/docs/postman-flows/reference/blocks/output-module/): Output block - [Blocks reference](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. Blocks may have input ports, output ports, or both. You can use these ports to connect your blocks and route information or trigger an action. - [The Record block](https://learning.postman.com/docs/postman-flows/reference/blocks/record/): Record block - [The Regex block](https://learning.postman.com/docs/postman-flows/reference/blocks/regex/): The **Regex** block is deprecated and isn't available in Postman Flows. To use a regular expression for processing data, include the regex in your TypeScript or FQL code in an [**Evaluate** block](/docs/postman-flows/reference/blocks/evaluate/). - [The Repeat block](https://learning.postman.com/docs/postman-flows/reference/blocks/repeat/): Repeat block - [The Request block](https://learning.postman.com/docs/postman-flows/reference/blocks/request/): Request block - [The Response block](https://learning.postman.com/docs/postman-flows/reference/blocks/response/): Response block - [The Schedule block](https://learning.postman.com/docs/postman-flows/reference/blocks/schedule/): Schedule block - [The Select block](https://learning.postman.com/docs/postman-flows/reference/blocks/select/): The Select block - [The Start block](https://learning.postman.com/docs/postman-flows/reference/blocks/start/): Start block - [The String block](https://learning.postman.com/docs/postman-flows/reference/blocks/string/): The String block - [The Template block](https://learning.postman.com/docs/postman-flows/reference/blocks/template/): Template block - [The Validate block](https://learning.postman.com/docs/postman-flows/reference/blocks/validate/): Validate block - [Flows actions overview](https://learning.postman.com/docs/postman-flows/reference/flows-actions-overview/): An *action* is a flow that's deployed in the Postman cloud. Unlike [*flow modules*](/docs/postman-flows/get-started/build-your-first-flow/), which must be run manually, actions can be triggered with automatic schedules, or with requests from webhooks, third-party apps, or other APIs. Actions are useful for running automations and exposing functionality as an API or as an AI tool for MCP servers. - [Action blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-action-blocks/): _Action blocks_ include the following: - [AI blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-ai-blocks/): _AI blocks_ include the following: - [Connector blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-connector-blocks/): You can connect third-party services to Flows actions with **Connector** blocks. Each **Connector** block connects services, like Calendly and Salesforce, to your Flow using OAuth 2.0. Once connected, your Flow can interact with the service, like searching and canceling events in Calendly, or getting a file in Figma. - [Data blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-data-blocks/): _Data blocks_ include the following: - [Logic blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-logic-blocks/): _Logic blocks_ include the following: - [Looping blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-looping-blocks/): _Looping blocks_ include the following: - [Trigger blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-trigger-blocks/): _Trigger blocks_ include the following: - [Visualize blocks overview](https://learning.postman.com/docs/postman-flows/reference/overview-visualize-blocks/): _Visualize blocks_ include the following: - [Flows 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). ### Mock server tutorials #### Advanced tutorials - [Automate repetitive tasks using Postman Flows](https://learning.postman.com/docs/postman-flows/tutorials/advanced/automate-repetitive-tasks/): You can use Postman Flows to complete repetitive tasks. Businesses often need to delete emails from multiple systems. Logging in, searching, and deleting emails from multiple locations can be time consuming. This tutorial shows you how to create a flow that deletes an email from three locations each time you run the flow. - [Create a dashboard using Postman Flows](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. For example, you can create an internet-of-things (IoT) dashboard that displays information about your home's thermostat, door locks, security cameras, and environmental sensors. Or you can create a dashboard that compares a stock's price to a market index to evaluate the stock's performance. The dashboard can visualize data with a true/false display and a line chart. - [Go further with advanced Flows tutorials](https://learning.postman.com/docs/postman-flows/tutorials/advanced/overview/): Continue your Postman Flows journey with these advanced tutorials. This curated collection walks you through common Flows tasks and concepts with real-world use cases. - [Run requests in sequence using Postman Flows](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, you can connect multiple **HTTP Request** blocks in sequence. This tutorial shows you how. - [Send information from one system to another using Postman Flows](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. For example, you can get customer profiles from a payment services provider like [Stripe](http://www.stripe.com) and add those profiles as contacts on a marketing platform like [Brevo](http://www.brevo.com). This tutorial shows you how to do this with Postman Flows. #### Beginner tutorials - [Calculate the years since a milestone](https://learning.postman.com/docs/postman-flows/tutorials/beginner/calculate-years-since-milestone/): You can build a flow to calculate the years since an important date, such as an anniversary, when one of your customers opened an account, or another important milestone. - [Create a count-based loop with the Repeat block](https://learning.postman.com/docs/postman-flows/tutorials/beginner/create-count-based-loop/): You can 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 list-based loop with the For block](https://learning.postman.com/docs/postman-flows/tutorials/beginner/create-list-based-loop/): You can 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. - [Get started with beginner Flows tutorials](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. - [Send a request with the HTTP Request block](https://learning.postman.com/docs/postman-flows/tutorials/beginner/send-request/): You can build a flow that uses a request from your workspace or the [Postman API Network](/docs/collaborating-in-postman/public-api-network/public-api-network-overview/). You can also create a new request when building your flow. - [Learn how to use Postman Flows with 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](/docs/postman-flows/tutorials/advanced/automate-repetitive-tasks/), [integrate systems](/docs/postman-flows/tutorials/advanced/send-information-from-one-system-to-another/), and [send requests](/docs/postman-flows/tutorials/beginner/send-request/) in flow modules. Use them to get familiar with the Flows interface and discover what you can do with Flows. #### Video tutorials - [Create your first Postman 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 in Postman Flows](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. With the [Create with AI](/docs/postman-flows/reference/blocks/create-with-ai/) block, you can generate text, images, and JSON data, all from plain-language prompts. It's a game changer for automating repetitive tasks, enhancing creativity, and speeding up your processes. - [Watch Flows video tutorials](https://learning.postman.com/docs/postman-flows/tutorials/video/overview/): Continue your Postman Flows journey with these video tutorials. This curated collection walks you through common Flows tasks and concepts with real-world use cases. You can learn about creating your first flow and generating AI in your flows. The videos also cover working with custom test data in scenarios, and versioning flows so you can use them as [modules](/docs/postman-flows/reference/blocks/flow-module/). - [Build and deploy apps 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. In this tutorial, you'll create an AI-powered weather application that runs entirely on Postman's cloud infrastructure - with no servers, no setup, and no complex deployment processes required. - [Postman Flows scenarios and test data](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. This means that scenarios enable you to define values for multiple inputs simultaneously depending on your current task, whether you're testing a new flow you're building or running a flow regularly. Scenarios are especially convenient when you're testing flows that require specific but different data. - [Postman Flows snapshots and modules](https://learning.postman.com/docs/postman-flows/tutorials/video/work-with-snapshots/): You can use _snapshots_ to save your flow at different points as it evolves over time. With snapshots, you can save, view, edit, and restore different versions of your flow. Snapshots are a great way to make changes without breaking your existing flow. Using snapshots also enables you to use [modules](/docs/postman-flows/reference/blocks/flow-module/) in your flows. ### TypeScript in flows - [Detect a session id cookie with TypeScript in Flows](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.sid` cookie is present in the response, it could indicate that a session ID has been leaked. By using TypeScript to check for the `sails.sid` cookie in an **If** or **Condition** block, you can route the response to different blocks, depending on the result. - [Route response data with TypeScript in Flows](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. The first expression to return `true` routes the response data through its output port. If none of the three TypeScript expressions resolve to true, the **Condition** block routes the response data through the **Default** output port. - [Use TypeScript in Postman Flows](https://learning.postman.com/docs/postman-flows/typescript/typescript-overview/): You can use [TypeScript](https://www.typescriptlang.org/) to enhance logic and functionality in the [logic blocks](/docs/postman-flows/reference/overview-logic-blocks/) of your Postman Flows. For example, with TypeScript you can write expressions that evaluate data informing your Flow's decisions, and functions that process data within your Flow. - [Rename headers with TypeScript in Flows](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. Renaming headers can be useful for normalizing field names for testing purposes and mapping fields to different data models. ## Document APIs - [Document your APIs in Postman](https://learning.postman.com/docs/publishing-your-api/api-documentation-overview/): [Documentation](https://www.postman.com/api-platform/api-documentation/) is an important part of your API. You can add documentation to any Postman Collection and its API requests. You can also use Postman to create API documentation and share it with your API's consumers, so they know what endpoints are available and how to interact with them. - [Write documentation in Postman](https://learning.postman.com/docs/publishing-your-api/authoring-your-documentation/): Postman [automatically generates documentation](/docs/publishing-your-api/document-a-collection/) for every collection you create, including [collections linked to an API](/docs/publishing-your-api/documenting-your-api/). The documentation includes all of the requests in your collection, along with examples, authorization details, and example code. - [Host API documentation with a custom domain](https://learning.postman.com/docs/publishing-your-api/custom-doc-domains/): **[Custom documentation domains are available with Postman paid plans.](https://www.postman.com/pricing/)** - [Document a collection in Postman](https://learning.postman.com/docs/publishing-your-api/document-a-collection/): Postman automatically generates basic documentation for any collection you create. The documentation includes details about all of the requests in your collection, along with sample code in various client languages. Request details include the method, authorization type, URL, headers, request and response structures, and examples. In addition, the documentation displays all key-value pairs for request parameters, headers, and bodies. - [Add API documentation in Postman](https://learning.postman.com/docs/publishing-your-api/documenting-your-api/): You can view, create, and manage your API's documentation either with collections or the Postman API Builder. You can add detailed API documentation to a collection with types. This enables you to add more details to request parameters, headers, and bodies in an HTTP collection. With the API Builder, you can also add detailed documentation for any OpenAPI 2.0 or 3.0 definition. You can then generate a collection from the API or add a copy of an existing collection. - [Publish documentation in Postman](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. Publish your documentation to help people around the world learn how to use your collection or interact with your public API. ### Add Run in Postman button - [Create a Run in Postman button for your API consumers](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. The **Run in Postman** button enables users to fork collections. You can embed the button in your website or a README to enable developers to interact with your API. - [Customize your Run in Postman button](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](/docs/publishing-your-api/run-in-postman/creating-run-button/). You can customize and embed this button in your website's client-side code so users can begin making calls to your API using Postman's `_pm()` method. The **Run in Postman** button enables users who click it to [fork](/docs/publishing-your-api/run-in-postman/creating-run-button/#use-a-run-in-postman-button) your collection and environment into their Postman workspace. - [Streamline the developer onboarding experience with the 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](/docs/postman-api-network/showcase/prepare/public-collections/), [curated them](/docs/postman-api-network/showcase/prepare/curate/overview/), and [published your public APIs](/docs/postman-api-network/showcase/publish/public-apis/), create a *Run in Postman* button. Then, add it to your developer website, API reference, documentation, and each of your public collection's overview pages. - [Set up Guided Auth for public APIs in Postman](https://learning.postman.com/docs/publishing-your-api/setting-up-authentication-for-public-apis/): You can onboard your API consumers by setting up Guided Auth for your public APIs in Postman. This feature enables you to communicate the steps users need to take make their first request to your API, such as registering for a developer account or creating an app on your dashboard. When a user creates a request to your API, Postman automatically recognizes that it requires authentication and prompts them with your provided steps to set it up. - [View documentation in Postman](https://learning.postman.com/docs/publishing-your-api/viewing-documentation/): [Documentation](/docs/publishing-your-api/api-documentation-overview/) helps you get more out of the collections and APIs that you work with in Postman. View documentation to learn more about the requests in a collection or how to interact with an API's endpoints. ## Reports - [View reports about API rule compliance in the Postman API Builder](https://learning.postman.com/docs/reports/api-builder-reports/): API Builder reports are available with [Postman Enterprise plans](https://www.postman.com/pricing/). - [View reports about API rule compliance in API specifications](https://learning.postman.com/docs/reports/api-governance-specifications-reports/): Governance reports are available with [Postman Enterprise plans](https://www.postman.com/pricing/). - [View reports about API security metrics](https://learning.postman.com/docs/reports/api-security-reports/): The [**API Security** report dashboard](https://go.postman.co/reports/api-security) provides metrics relevant to the [API Security](/docs/api-governance/api-testing/api-testing-warnings/) posture of your Postman APIs. - [View reports about billing and resource consumption](https://learning.postman.com/docs/reports/billing-overview-reports/): [**Reports are available with all Postman Enterprise plans.**](https://www.postman.com/pricing/) - [View reports about workspaces and APIs](https://learning.postman.com/docs/reports/content-activity-reports/): [**Reports are available with all Postman Enterprise plans.**](https://www.postman.com/pricing/) - [View reports about internal workspaces](https://learning.postman.com/docs/reports/internal-workspaces-reports/): [**Reports are available with all Postman Enterprise plans.**](https://www.postman.com/pricing/) - [View reports about team invites, member activity, and role distribution](https://learning.postman.com/docs/reports/members-overview-reports/): [**Reports are available with all Postman Enterprise plans.**](https://www.postman.com/pricing/) - [View reports about your team and plan](https://learning.postman.com/docs/reports/overview-reports/): [**Reports are available with all Postman Enterprise plans.**](https://www.postman.com/pricing/) - [View reports on usage, security, and billing in Postman](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.__](https://www.postman.com/pricing/) - [View reports about detected, unresolved, and resolved secrets](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.](https://www.postman.com/pricing/#advanced-security-administration)** ## Send requests ### Authentication and authorization - [Authenticate with Akamai EdgeGrid authentication in Postman](https://learning.postman.com/docs/sending-requests/authorization/akamai-edgegrid/): [Akamai EdgeGrid](https://techdocs.akamai.com/home) is an authorization helper developed and used by Akamai. - [Authenticate with Atlassian S2S in Postman](https://learning.postman.com/docs/sending-requests/authorization/atlassian/): Atlassian S2S Authentication Protocol (ASAP) is a [JSON Web Token](https://datatracker.ietf.org/doc/html/rfc7519) (JWT) bearer token that an API server can use to authenticate requests from the client. - [Set up authorization for public APIs using Guided Auth](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. When you create an HTTP request to an API that supports Guided Auth, Postman automatically recognizes if the API requires authentication. You can then follow steps by API publishers to set up authentication credentials for the public API and store them in your [Postman Vault](/docs/sending-requests/postman-vault/postman-vault-secrets/) as vault secrets. - [Authorization types supported by Postman](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. You can choose an authorization type on requests, collections, or folders. - [API authentication and authorization 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. Authentication involves verifying the identity of the request sender, while authorization confirms that the sender has permission to carry out the endpoint's operation. - [Authenticate with AWS Signature authentication workflow in Postman](https://learning.postman.com/docs/sending-requests/authorization/aws-signature/): AWS Signature is the authorization workflow for Amazon Web Services requests. AWS uses a custom HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code) for authentication. - [Add and manage CA and client certificates in Postman](https://learning.postman.com/docs/sending-requests/authorization/certificates/): You can add and manage certificates in Postman to enable authentication when sending requests. Certificates added to Postman are stored locally and aren't synced to the Postman cloud. - [Authenticate with Digest access authentication in Postman](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. Response details include a number that can be used only once (a *nonce*), a realm value, and a `401 Unauthorized` response. You then send back an encrypted array of data, including a username and password combined with the data received from the server in the first request. The server uses the passed data to generate an encrypted string and compares it against what you sent to authenticate your request. - [Authenticate with Hawk access authentication in Postman](https://learning.postman.com/docs/sending-requests/authorization/hawk-authentication/): Hawk authentication enables you to authorize requests using partial cryptographic verification. - [Authenticate with Windows NTLM authentication in Postman](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. - [Authenticate with OAuth 1.0 authentication in Postman](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. For example, as a user of a service, you can grant another application access to your data with that service without exposing details like your username and password. Accessing user data with OAuth 1.0 involves a few requests back and forth between client application, user, and service provider. - [Authenticate with OAuth 2.0 authentication in Postman](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. Access tokens are typically short-lived, but the authorization server can also provide a long-lived refresh token. A client application can use the refresh token to automatically [refresh the access token](#refreshing-an-oauth-20-token). - [Add API authorization details to requests in Postman](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. The correct data values are determined by your API at the server side. If you're using a third-party API, refer to the provider's documentation for any required auth details. ### Capture API traffic - [Capture HTTP traffic and sync cookies in Postman](https://learning.postman.com/docs/sending-requests/capturing-request-data/capture-overview/): Capturing HTTP traffic is an important tool for API development and testing. Postman enables you to inspect the requests passing between client applications and your API and save them to a collection. You can use the saved requests to understand how your API is behaving and to assist with debugging. - [Capture traffic using the Postman built-in proxy](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, you may want to check the HTTP and HTTPS request traffic sent and received in the app. Sometimes you might discover undocumented APIs. You can capture network traffic, including requests, responses, and cookies, using the proxy that's built into Postman. - [Capture HTTP requests in Postman](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).** If you're on macOS (Postman v10.17 or later) or Windows (Postman v10.18 or later), go to [Capturing requests with the Postman proxy](/docs/sending-requests/capturing-request-data/capture-with-proxy/) instead. To check which version of Postman you're using, select Setting icon **Settings** in the header, then select **Settings > About**. - [Capture HTTPS traffic using the Postman built-in proxy](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, and Windows devices. - [Capture traffic from a web browser using Postman 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. Interceptor enables you to capture API traffic, including requests and cookies, from a web browser. After capturing requests or cookies, you can view and work with them in Postman. - [Sync cookies using Postman Interceptor and the Postman proxy](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](/docs/sending-requests/response-data/cookies/). You can sync cookies using either the Postman proxy or Postman Interceptor at any time, without having to start a [proxy or Interceptor session](/docs/sending-requests/capturing-request-data/capture-overview/). ### Create requests - [Create and send API requests in Postman](https://learning.postman.com/docs/sending-requests/create-requests/create-requests/): You can use the Postman API client to connect to APIs you're building, testing, or integrating with. Build and send API requests with parameters, body data, and headers. Save your requests in collections so you can collaborate on them with your team or use them in automated testing. - [Generate code snippets from API requests](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. Postman can generate code snippets for a variety of programming languages and client libraries, including Postman CLI, C#, JavaScript, and NodeJS. - [Configure headers for API requests in Postman](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. You can configure request headers in Postman, and save groups of headers as presets for quick access. Postman also automatically adds headers to your requests as needed depending on your request selections. - [Group API requests with Postman 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. You can use collections to keep your workspace organized, collaborate with teammates, and generate API documentation and API tests. You can also use collections to automate request runs as part of your API testing efforts. - [Send parameters and body data with API requests in Postman](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. You can also add body data to a request in various formats, including form data, URL-encoded, raw, and binary. - [Send a request with the Postman API client](https://learning.postman.com/docs/sending-requests/create-requests/request-basics/): Postman supports sending requests using HTTP, [GraphQL](/docs/sending-requests/graphql/graphql-overview/), [gRPC](/docs/sending-requests/grpc/grpc-client-overview/), [WebSocket](/docs/sending-requests/websocket/websocket-overview/), [MQTT](/docs/sending-requests/mqtt-client/mqtt-client-overview/), and [SOAP](/docs/sending-requests/soap/making-soap-requests/) protocols. Postman also supports AI-driven development with [AI requests in collections](/docs/postman-ai/ai-requests/overview/) and [AI Request blocks in Postman Flows](/docs/postman-ai/ai-request-blocks/overview/). You can also use Postman as your Model Context Protocol (MCP) client and [send requests to MCP servers](/docs/postman-ai/mcp-requests/overview/). - [Select custom settings for API requests in Postman](https://learning.postman.com/docs/sending-requests/create-requests/request-settings/): You can configure a variety of settings for your API requests in Postman. These settings enable you to customize Postman's behavior when sending a request. For example, you can turn on SSL certificate validation or turn off URL encoding for a request. - [Upload files for shared requests and cloud runs](https://learning.postman.com/docs/sending-requests/create-requests/test-data/): Test data storage is available with [Postman Free, Basic, and Professional plans](https://www.postman.com/pricing/). To learn more about availability with Enterprise plans, contact the [Postman sales team](https://www.postman.com/company/contact-sales/). ### GraphQL - [Create GraphQL requests in Postman](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 GraphQL client interface is specifically designed for crafting GraphQL requests. It enables you to explore a GraphQL API's data fields and construct queries by selecting fields or entering code in an editor. For requests with multiple queries, you can select specific queries and run them individually. - [The GraphQL client interface](https://learning.postman.com/docs/sending-requests/graphql/graphql-client-interface/): Postman has a special client for GraphQL requests called the GraphQL client. When you create a GraphQL request in Postman, the GraphQL client loads automatically. The GraphQL client has features that enable you to create and run GraphQL requests more efficiently. - [Make a GraphQL call with an HTTP request](https://learning.postman.com/docs/sending-requests/graphql/graphql-http/): Postman's [GraphQL client](/docs/sending-requests/graphql/graphql-overview/) is tailored for making GraphQL requests, but you can also create GraphQL requests using Postman's [HTTP request interface](/docs/sending-requests/create-requests/request-basics/). The HTTP request interface might be better for some use cases, like working with legacy systems or projects that include both GraphQL and non-GraphQL APIs. - [GraphQL in Postman](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 - [Invoke a gRPC request in Postman](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. The procedure below uses a unary method and shows how to add an example message to your request. There are also some troubleshooting tips in case you encounter any issues. - [Manage gRPC APIs using Postman](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. Using a gRPC request, you can view supported services and methods (with a service definition), invoke the method of your interest, send a message payload, view the response from the server, and save example responses without entering commands in the terminal or writing any code. - [The gRPC client interface](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. For example, it includes a dropdown list that shows the methods available on the server. This topic highlights the various parts of the gRPC client interface and how to use them. - [Test and debug values in gRPC requests using JavaScript in Postman](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 and [multi-protocol collections and folders](/docs/collections/use-collections/add-requests-to-collections/#about-multi-protocol-collections). You can define scripts for three hooks available during the request run lifecycle: - [Read and write gRPC data using the Postman 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)](https://developers.google.com/protocol-buffers). Unlike other data formats such as JSON or XML, which are text-based, protobuf uses a binary format. Binary formats aren't meant to be read by humans, so Postman provides a **JSON interface** that enables you to read and write data when using gRPC. - [Save, edit, and share gRPC request-response examples](https://learning.postman.com/docs/sending-requests/grpc/using-grpc-examples/): You can save, edit, and share gRPC request-response pairs as [examples](/docs/sending-requests/response-data/examples/). You can even create gRPC examples from scratch. - [Create and use gRPC mock servers](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, but another team is responsible for implementing those endpoints, and aren't finished yet. Instead of being blocked by this, you can use a mock server, which returns sample data for requests to the API's endpoints, simulating the behavior of a real API. You can then use the mock server to test your API, before it's even implemented by the other team. - [Manage service definitions for gRPC requests in Postman](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. A service definition enables this. On the client side, a service definition makes the client aware of the server's supported services, methods, fields, data types, and message payload structure. Anything that doesn't follow the regulations enforced by the service definition results in an error. During the request run, the service definition is used to serialize the information exchanged between both parties. ### MQTT - [Creating your first 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. - [MQTT overview](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). Its usage spans from small devices for home automation and wearables, to automating large-scale industrial machineries. It's a lightweight technology where clients connected to a single broker can publish messages to different topics and subscribe to topics to receive messages from other connected clients. The messages are transferred with low-bandwidth usage, low-power consumption, and efficient distribution of information to one or many receivers, all adding to the popularity of MQTT. - [Using the MQTT request interface](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. This topic highlights parts of the request interface and explains how to use them. ### Postman Vault - [Integrate Postman Vault with 1Password](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.](https://www.postman.com/pricing/)** - [Integrate Postman Vault with AWS Secrets Manager](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.](https://www.postman.com/pricing/)** - [Integrate Postman Vault with Azure Key Vault](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.](https://www.postman.com/pricing/)** - [Integrate Postman Vault with HashiCorp Vault](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.](https://www.postman.com/pricing/)** - [Export and import vault secrets](https://learning.postman.com/docs/sending-requests/postman-vault/import-export-vault-secrets/): > Exporting and importing vault secrets is in open beta on [Postman Free plans](https://www.postman.com/pricing/). - [Manage Postman Vault integrations](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.](https://www.postman.com/pricing/)** - [Create and manage 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](#add-authorization-as-vault-secrets-using-guided-auth) to your Postman Vault, enabling you to store authentication credentials for public APIs that set up Guided Auth. You can use vault secrets added using Guided Auth in your Postman team. Then you can [reference vault secrets added using Guided Auth](#use-vault-secrets-added-using-guided-auth) in new HTTP requests to the same public APIs. Only you can access and use values associated with your encrypted vault secrets, and vault secrets aren't synced to the Postman cloud. - [Create and manage vault secrets](https://learning.postman.com/docs/sending-requests/postman-vault/manage-vault-secrets/): [Add vault secrets](#add-sensitive-data-as-vault-secrets) to your Postman Vault and reuse them in your local instance of Postman. Then you can [reference vault secrets](#use-vault-secrets) in your HTTP collections and requests, variables, and the Collection Runner. Only you can access and use values associated with your encrypted vault secrets, and vault secrets aren't synced to the Postman cloud. - [Integrate Postman Vault with external vaults](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.](https://www.postman.com/pricing/)** - [Manage your vault key](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-key/): Postman generates a [vault key](#save-your-vault-key) when you open your Postman Vault for the first time. Your vault key is used to open your Postman Vault when you sign in to Postman. Save or download your vault key to a secure location, then you can choose to store your vault key in your system's password manager. Your vault key isn't synced to the Postman cloud. You can [reset your vault key](#reset-your-vault-key) if you lose it. - [Store secrets in 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. This enables you to securely reuse sensitive data in your HTTP collections and requests. Only you can access and use values associated with your vault secrets, and they aren't synced to the Postman cloud. - [Troubleshoot vault secrets](https://learning.postman.com/docs/sending-requests/postman-vault/troubleshoot-vault-secrets/): A [vault secret](/docs/sending-requests/postman-vault/manage-vault-secrets/), [vault secret added using Guided Auth](/docs/sending-requests/postman-vault/manage-vault-secrets-using-guided-auth/), or vault secret linked with an [external vault integration](/docs/sending-requests/postman-vault/postman-vault-integrations/) can be empty or unresolved in your HTTP requests. An _empty vault secret_ is a vault secret that doesn't have a value but is referenced in your request. An empty vault secret may or may not exist in your Postman Vault. An _unresolved vault secret_ is a vault secret that exists in your Postman Vault but the value can't be accessed from your request. - [Send API requests and get response data in Postman](https://learning.postman.com/docs/sending-requests/requests/): Whether you're building or testing your own API, or integrating with a third-party API, you can send requests in Postman to connect to APIs you're working with. Your requests can retrieve, add, or delete data, and can send parameters and authorization details. ### Response data and cookies - [Create and capture cookies using Postman's cookie manager](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. You can manually create cookies for a domain, or you can [capture cookies](/docs/sending-requests/capturing-request-data/syncing-cookies/) using the Postman proxy or Postman Interceptor. You can then use the cookies stored in the Postman cookie jar when sending requests in Postman. - [Create examples of request responses to illustrate API use cases](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. You can add an example to a request by saving a response, or you can create an example with a custom response to illustrate a specific use case. Once you've created examples, you can use them to set up a mock server or add more detail to your API documentation. - [Work with API response data and cookies in Postman](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. You can use Postman to inspect response data, create visualizations, and troubleshoot problems. You can also save responses as examples for reference, and view and manage any associated cookies. - [API response structure in Postman](https://learning.postman.com/docs/sending-requests/response-data/responses/): The Postman response viewer helps you visualize and check the correctness of API responses. An API response consists of the response body, headers, cookies, and the HTTP status code. You can view details about the response, including test results, network information, response size, response time, and security warnings. You can also save responses as examples or files. - [Debug API requests in Postman](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. You can ask Postbot to help you find out what the problem is, or use the Postman Console to troubleshoot the request. This guide also lists some common issues and their causes. - [Visualize request responses using Postman Visualizer](https://learning.postman.com/docs/sending-requests/response-data/visualizer/): The _Postman Visualizer_ provides a programmable way to visually represent your request [responses](/docs/sending-requests/response-data/responses/). You can also use Postman's AI assistant Postbot to automate your visualization. If you add a visualization script to the **Scripts** tab of your request, the result renders in the Image icon **Visualization** tab for the response body. If you don't create a Visualizer script, you can select Postbot icon **Visualize** to get Postbot to generate the visualization. ### SOAP - [Make HTTP calls using the SOAP protocol](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. In this example, the SOAP endpoint validates an ISBN book number. ### Unix sockets and named pipes - [Send requests over Unix sockets or named pipes](https://learning.postman.com/docs/sending-requests/uds-named-pipes/send-uds-named-pipes-requests/): If you are running a local server, Postman can send requests to that server using [Unix domain sockets](https://en.wikipedia.org/wiki/Unix_domain_socket) (UDS) on macOS or Linux, or [named pipes](https://en.wikipedia.org/wiki/Named_pipe#In_Windows) on Windows. This is a form of [inter-process communication](https://en.wikipedia.org/wiki/Inter-process_communication) (IPC). Unix domain sockets are also called Unix sockets. ### Variables and environments - [Organize your workspace environments with colors](https://learning.postman.com/docs/sending-requests/variables/environment-colors/): Assign colors to your workspace's [environments](/docs/sending-requests/variables/managing-environments/) to help you organize environments in your team's development cycle. You can [assign](#assign-a-color-to-an-environment) specific colors to define an environment and its intended purpose, such as development, staging, or production. - [Edit and set environment variables in Postman](https://learning.postman.com/docs/sending-requests/variables/environment-variables/): An [environment](/docs/sending-requests/variables/managing-environments/) is a group of variables whose values you can change depending on your work context in Postman. After you [create an environment](/docs/sending-requests/variables/managing-environments/#create-an-environment), you can add new environment variables, update their values, or delete variables. You can also set environment values using scripts, and you can share variable values to make them available to your team. - [Group sets of variables in Postman using environments](https://learning.postman.com/docs/sending-requests/variables/managing-environments/): In Postman, an _environment_ is a set of one or more [variables](/docs/sending-requests/variables/variables/) that you can reference when [sending requests](/docs/sending-requests/create-requests/create-requests/), [writing pre-request scripts](/docs/tests-and-scripts/write-scripts/pre-request-scripts/), or [writing post-response scripts](/docs/tests-and-scripts/write-scripts/test-scripts/). You can create environments for the different types of work you do in Postman. When you switch between environments, all of the variables in your requests and scripts will use the values from the current environment. This is helpful if you need to use different values in your requests depending on the context, for example, if you're sending a request to a test server or a production server. - [Pin environments to collections](https://learning.postman.com/docs/sending-requests/variables/pinned-environments/): You can pin [environments](/docs/sending-requests/variables/managing-environments/) to an HTTP collection to organize your workspace and show other Postman users which environments work with that collection. If a user [forks](/docs/collaborating-in-postman/using-version-control/forking-elements/) the collection, pinned environments will fork with the collection. By associating environments with collections, pinning helps other users understand and consume your requests. - [Work with environments as a team in Postman](https://learning.postman.com/docs/sending-requests/variables/team-environments/): An [environment](/docs/sending-requests/variables/managing-environments/) enables you to collaborate on Postman data when you're working as part of a team. You can use environments to share a group of variable values and use those values when sending requests. You can also use environments to share and manage the visibility of sensitive data such as API keys, passwords, or tokens. - [Reuse data with variables and environments in Postman](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. You can group variables in an _environment_ to make it easier to change variable values based on your work context. - [Store and reuse values using variables](https://learning.postman.com/docs/sending-requests/variables/variables/): _Variables_ enable you to store and reuse values in Postman. By storing a value as a variable, you can reference it throughout your collections, environments, requests, and scripts. Variables help you work efficiently, collaborate with teammates, and set up dynamic workflows. ### WebSocket - [Add details to a WebSocket or Socket.IO request](https://learning.postman.com/docs/sending-requests/websocket/add-details-websocket/): You can add details to your WebSocket or Socket.IO request, such as parameters, headers, and connection settings. Click the **Params**, **Headers**, or **Settings** tab to make changes. - [Create a Socket.IO 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.IO requests from the sidebar in Postman. - [Create a WebSocket Request](https://learning.postman.com/docs/sending-requests/websocket/create-a-websocket-request/): You can create a WebSocket request from the sidebar in Postman. - [Document WebSocket requests](https://learning.postman.com/docs/sending-requests/websocket/document-websocket-requests/): Postman automatically generates documentation for each of your requests. The documentation includes the request's URL, parameters, settings, and any saved messages. You can also add a description to help users understand how to use the request. - [Listen to Socket.IO events](https://learning.postman.com/docs/sending-requests/websocket/listen-to-socketio-events/): You can configure Socket.IO requests to listen to specific events. The **Response** pane displays the received events that the request is listening to. Events are color coded to make them more identifiable. - [Save WebSocket requests](https://learning.postman.com/docs/sending-requests/websocket/save-websocket-requests/): You can save your WebSocket requests to a collection. This enables you to reuse requests, share them with other team members, and add documentation to the collection of requests. - [Troubleshoot WebSocket requests](https://learning.postman.com/docs/sending-requests/websocket/troubleshoot-websocket-requests/): You can use the Postman Console to debug issues with a WebSocket connection. To open the Console and view log messages, select Console icon **Console** in the Postman footer. - [Use variables in WebSocket requests](https://learning.postman.com/docs/sending-requests/websocket/use-variables-with-websocket/): You can use Postman variables in the URL of a WebSocket connection or the body of a message. For example, you can create a variable named "my_host", set the value to "example.com", and then use "ws://{{my_host}}/api/example" as a URL. If you enter "\{\{" in either the URL box or message editor, you can autocomplete your variables. - [Send WebSocket requests with Postman](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. The data can be passed in both directions with low latency and overhead, and without breaking the connection. - [Work with WebSocket messages](https://learning.postman.com/docs/sending-requests/websocket/work-with-websocket-messages/): _WebSocket messages_ are data packets sent over a WebSocket connection. WebSocket messages include information about the type and length of the message, and whether it's the final message or part of a larger set of messages. You can send, save, and view WebSocket messages in Postman. You can also add names and arguments to Socket.IO events. ## Tests and scripts ### Run and automate tests - [Run API tests manually in Postman](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests-manually/): In Postman, you can run your [functional API tests](/docs/tests-and-scripts/test-apis/test-apis/) at any time. Running tests manually enables you to run tests on demand and view the results right away. For example, you can check if an endpoint is working or verify that a code change fixes a specific error. - [Run API tests on a schedule in Postman](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests-on-schedule/): In Postman, you can run your [functional API tests](/docs/tests-and-scripts/test-apis/test-apis/) automatically on a schedule. Use the _Collection Runner_ to select a test suite, change the run order of tests, and set the run schedule. Each time the collection runs, you'll get notified if any tests fail. - [Run API tests in your CI/CD pipeline using Postman](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. At the same time, it's important to maintain software quality. Running API tests automatically during the build process helps to ensure that every code change is ready for production. - [Run and automate API tests in Postman](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. After [setting up your tests in Postman](/docs/tests-and-scripts/test-apis/test-apis/), you can run tests manually as needed, or you can automate your tests to save time and increase test coverage. - [Run API tests using Postman Monitors](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. When you [set up a monitor](/docs/monitoring-your-api/setting-up-monitor/), you choose a collection with the requests and post-response scripts you want to run, and you specify how frequently Postman runs the collection. You'll be notified if a test fails, and all results are recorded on the [monitor's dashboard](/docs/monitoring-your-api/viewing-monitor-results/). ### Test APIs - [Test end-to-end API workflows in Postman](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. End-to-end testing touches multiple components in your application and ensures the entire system works as expected. It also identifies issues in real-world workflows before they can impact users. - [Test API integrations and data flow in Postman](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. _Integration testing_ makes sure that the different parts of your application are compatible with one another. It also tests how your application functions with other systems, like databases and third-party services. - [Test your API's performance in Postman](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. _Performance testing_ enables you to simulate user traffic, so you can observe how your API behaves under load and identify any issues or bottlenecks. - [Test your APIs for regressions in Postman](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. Regression tests ensure that your API keeps working as expected after any updates or changes. They can also identify new bugs or issues introduced during development and verify that your changes are backwards compatible. - [Test API functionality and performance in Postman](https://learning.postman.com/docs/tests-and-scripts/test-apis/test-apis/): Testing is a critical part of the API development lifecycle. Testing confirms that API endpoints, methods, and integrations work as expected and that your API can meet the expected load. - [Test APIs and write scripts in Postman](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. With Postman, you can run API tests in the same place where you collaborate and build APIs with your team. ### Write scripts - [Use scripts to add logic and tests to Postman requests](https://learning.postman.com/docs/tests-and-scripts/write-scripts/intro-to-scripts/): Postman's runtime is based on [Node.js](https://nodejs.org/en/about). You can use this to write scripts that add dynamic behavior to requests and collections. You can use pre-request and post-response scripts to write API tests, build requests that can contain dynamic parameters, or pass data between requests. #### Use packages in scripts - [Import packages from external registries in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/external-package-registries/): You can [import public packages](#import-a-public-package) from external package registries into your scripts. Postman supports importing public packages from [npm](https://www.npmjs.com/) and [JSR](https://jsr.io/) registries. If you're on a Postman Professional or Enterprise plan, you can also [import private packages](#import-a-private-package) from npm that a Team Admin configured access to. You can import external packages in your internal, partner, and public workspaces. External packages are supported in HTTP, gRPC, and GraphQL requests. - [Import packages into Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/overview/): You can import packages from your team's Postman Package Library into scripts in your internal workspaces. You can also import packages from external packages registries, such and npm or JSR, into your scripts. Postman supports importing packages into HTTP, gRPC, and GraphQL requests. - [Add internal scripts to the Package Library in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/package-library/): With the Postman Package Library, you can maintain scripts and tests in a central location and share them with your team. Add commonly used scripts and tests to packages in your team's package library, and reuse them in your internal workspaces. The package library supports HTTP, gRPC, and GraphQL requests. #### Postman sandbox reference - [Postman Sandbox API reference](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/overview/): Postman provides JavaScript APIs with the `pm` object, enabling you to test and access request and response data in your test scripts run in the [Postman Sandbox](https://github.com/postmanlabs/postman-sandbox). You can use the `pm` object to access request and response details, write assertions, and access and use variables. You can also use the `pm` object to send HTTP requests and other meta information in the Postman Sandbox. - [Access cookies in Postman scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-cookies/): You can use the `pm.cookies` methods to access and manipulate cookies for the domain in the request URL. You can also use the `pm.cookies.jar()` methods to access and manipulate cookies for any specified domain. - [Use scripts in collection runs](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-execution/): The `pm.execution` object provides information and context about requests and their responses during a [collection run](/docs/collections/running-collections/intro-to-collection-runs/), such as sending requests or which request is running, its position in a collection, and run-related metadata. - [Reference request metadata in scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-info/): The `pm.info` object provides meta information related to the request and the script itself. - [Reference message data in scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-message/): The `pm.message` object provides access to the data returned in the message that's received from the server. `pm.message` is only available in **On message** scripts. - [Reference Postman requests in scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-request/): The `pm.request` object provides access to the data for the request from a script running within it. `pm.request` is available in both **Before invoke** and **After response** scripts. For a **Pre-request** script, this is the request that's about to run. For a **Post-response** script, this is the request that has already run. - [Import packages into your scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-require/): You can use the `pm.require` method to import packages from your team's [Package Library](/docs/tests-and-scripts/write-scripts/packages/package-library/) or [external package registries](/docs/tests-and-scripts/write-scripts/packages/external-package-registries/) inside scripts in HTTP, gRPC, and GraphQL requests. - [Reference Postman responses in scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-response/): The `pm.response` object provides access to the data returned in the response for the current request. This object is only available in **Post-response** scripts. - [Use scripts to send requests in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-send-request/): Use the `pm.sendRequest` method to send a request asynchronously from a **Pre-request** or **Post-response** script in HTTP requests. For gRPC scripts, you can use the method in **Before invoke**, **On message**, and **After response** scripts. - [Writing tests and assertions in scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-test-expect/): You can add test specifications and assertions to your scripts using the [pm.test](#pmtest) and [pm.expect](#pmexpect) methods. - [Reference variables in Postman scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-variables/): Access and manipulate [variables](/docs/sending-requests/variables/variables/) in your scripts at a variety of [variable scopes](#variable-scope-precedence) with the `pm` object. You can use the [pm.globals](#pmglobals), [pm.collectionVariables](#pmcollectionvariables), [pm.environment](#pmenvironment), [pm.iterationData](#pmiterationdata), and [pm.variables](#pmvariables) methods to access variables at individual scopes. - [Reference vault secrets in Postman scripts](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-vault/): Access and manipulate [vault secrets](/docs/sending-requests/postman-vault/postman-vault-secrets/) in your scripts with the `pm.vault` methods. You must [enable support for vault secrets in scripts](#enable-support-for-vault-secrets-in-scripts). When you send a request or manually run a collection that uses the `pm.vault` methods, you'll be prompted to [grant or deny](#grant-scripts-access-to-your-vault-secrets) the collection or workspace access to your vault secrets using scripts. - [Script Postman visualizations](https://learning.postman.com/docs/tests-and-scripts/write-scripts/postman-sandbox-reference/pm-visualizer/): You can use the `pm.visualizer` object and the `pm.getData` method to visually represent your API's request responses with the [Postman Visualizer](/docs/sending-requests/response-data/visualizer/). - [Write pre-request scripts to add dynamic behavior in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/pre-request-scripts/): You can use pre-request scripts in Postman to run JavaScript before a request runs. By including code in the __Pre-request__ tab for a request, collection, or folder, you can carry out pre-processing such as setting variable values, parameters, headers, and body data. You can also use pre-request scripts to debug code, for example, by logging output to the Postman Console. - [Postman test script examples](https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-examples/): Depending on your test logic and how you want to get the results, there are various ways to structure the test assertions in a test script. This page provides post-response script examples for various API testing scenarios in Postman. You can use these post-response scripts in your request to parse response data and make assertions. You can also use these scripts to validate response structure and troubleshoot common test errors. - [Write scripts to test API response data in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-scripts/): You can use post-response scripts in Postman to run JavaScript after a request runs. By including code in the **Scripts > Post-response** tab for a request, collection, or folder, you can write and validate API tests. You can also use post-response scripts for debugging your tests. - [Troubleshoot common test errors](https://learning.postman.com/docs/tests-and-scripts/write-scripts/troubleshoot-tests/): When you encounter errors or unexpected behavior in your post-response scripts, [the Postman Console](/docs/sending-requests/response-data/troubleshooting-api-requests/) can help you to identify the source. - [Use dynamic variables to return randomly generated data](https://learning.postman.com/docs/tests-and-scripts/write-scripts/variables-list/): The [Faker](https://www.npmjs.com/package/@faker-js/faker) library enables you to generate sample data in Postman using predefined variables. Use these variables like you would any other variable in Postman. Their values are generated when the request runs, and their names start with a `$` symbol, for example, `$guid` or `$timestamp`. --- ## 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. Last updated: Dec 16, 2025