New button

You can use the New button to initiate:

The New button also provides access to templates and the API_network.

new_button

When you click the New button, the Create New tab appears as the default view.

In addition to the Create New tab, there are two other tabs: “Templates” and “API Network”. For more information about these tabs, see the Templates and API Network sections below.

new_button

Create New

In BUILDING BLOCKS, create a new request, collection, or environment.

In ADVANCED, create a new monitor, documentation, and a mock server.

Note: At the bottom, you can select “Show this window at launch” to indicate whether you want the Create New tab to display each time you open Postman.

Note: You can directly create a new feature when you click the down arrow at the right side of the New button.

new_button

BUILDING BLOCKS

Creating requests

You can create any kind of HTTP request.

  1. In the header toolbar, click the New button.
  2. In the Create New tab, click “Request”.
  3. Select a collection and save the request in it.

You can either create a new collection or select an existing one. After you save the request, you can add the URL, method, headers, and body to the request in the builder.

new_button

Creating collections

A collection is a group of individual requests that you can organize into folders.

  1. In the header toolbar, click the New button.
  2. In the Create New tab, click “Collection”.
  3. In the CREATE A NEW COLLECTION modal:
    • Enter a name and optional description.
    • Select an authorization type.
    • Enter a pre-request script to execute before the collection runs.
    • Add a test to execute after the collection runs.
    • Add variables to the collection and its requests.
  4. Click the Create button.

After creating the collection, you can save requests to the collection and add folders for better organization.

new_button

Creating environments

While working with APIs, you often need different setups, such as your local machine, the development server, or the production API. Environments let you customize requests using variables.

  1. In the header toolbar, click the New button.
  2. In the Create New tab, click “Environment”.
  3. In the MANAGE ENVIRONMENTS modal, add the variables you want to save as key-value pairs.
  4. Click the Add button.

new_button

If you’ve created other environments, the MANAGE ENVIRONMENTS modal appears again and displays them. You can share, edit, download, or delete those environments. In addition, you can create global environments and download them as a JSON file, or import environment files from your computer.

new_button

ADVANCED

Creating monitors

A monitor runs a collection periodically to check its performance and response. You can set a monitor to run as frequently as every 5 minutes.

create screen

Note: At the bottom, you can select “Show this window at launch” to indicate whether you want the Create New tab to display each time you open Postman.

  1. In the header toolbar, click the New button.
  2. In the Create New tab, click “Monitor”.
  3. Select if you want to monitor a new API or an existing or team collection. If you create a new API to monitor, you must select a request method and enter the request path, response code, and response body. If you use an existing or team collection, you must select a collection from a list of existing or team collections.

request monitor

  1. After you select or create the request you want to monitor, click the Next button.
  2. In the Configuration tab, you must:
  • Enter the name of the monitor
  • Select an environment (optional).
  • Set how frequently the monitor should run.
  • Select one or more regions of the world from where you want to monitor your results.

configure monitor

  1. Click the Create button.

In the Next steps tab, see a list of suggested next steps to get the most out of your monitor.

next monitor

Creating documentation

You can create public or private documentation and share it in a web page. Postman generates and hosts browser-based documentation for your collections automatically in real-time.

  1. In the header toolbar, click the New button.
  2. In the Create New tab, click “API Documentation”.
  3. Select if you want to create documentation for a new API or an existing or team collection. If you create a new API to document, you must select a request method and enter the request URL, description, and status code. If you use an existing or team collection to document, you must select a collection from a list of existing or team collections. configure docs
  1. After you select or create the request you want to document, click the Next button.
  2. In the Configure documentation tab, you must:
  • Enter the name of the documentation.
  • Add a description of the documentation. You can use markdown to add headings, lists, code snippets, and so on in your description.

configureTab docs

  1. Click the Create button.

In the Next steps tab, see a list of suggested next steps to get the most out of your documentation.

nextSteps docs

Creating mock servers

A mock server simulates each endpoint in a Postman Collection. You can mock a request and response in Postman before you send the actual request or set up a single endpoint to return the response.

  1. In the header toolbar, click the New button.
  2. In the Create New tab, click “Mock Server”.
  3. Select if you want to mock a new API or an existing or team collection. If you create a new API to mock, you must select a request method and enter the request path, response code, and response body. If you use an existing or team collection to mock, you must select a collection from a list of existing or team collections.

config mock

  1. After you select or create the request you want to mock, click the Next button.
  2. In the Configure mock server tab, you must:
  • Enter the name of the mock
  • Select an environment (optional).
  • Indicate if you want to make this mock server private

Note: The number of calls made to mock servers might be limited by your Postman account. Check your usage limits.

configTab mock

  1. Click the Create button.

In the Next steps tab, see a list of suggested next steps to get the most out of your mock server.

next mock

Template and API Network tabs

Templates

You can select ‘Templates’ to help you: check links, track Github issues, verify non-MFA access to AWS accounts, monitor the status of URLs, check DNS records, use Postman Echo to test your REST client and make sample API calls, and monitor AWS ElasticBeanstalk environments.

You can view all the templates, or select to view them in the “Developer” or “DevOps” category.

templates

To import a template:

  1. Click on the template you want. In this example we’re using the “Link Checker” template.

Note: Each template has a description that lists the values required to run the template. In this example, the Link Checker template requires a start_url and a root_url.

linkCheckertemplates

  1. Click the Use this template button to summon the Customization options screen.

This screen lists what Postman will create for you with this template and some configuration options available to you. Postman saves the values you enter as environment variables. Make sure you fill all the fields as these values might be crucial for the template to work properly.

  1. To configure your monitor, select how often you want the monitor to run and enter the URL you want to monitor in "CONFIGURATION OPTIONS" section.
  2. Click the Create button.

The Success! screen displays what Postman created for you and suggests next steps to consider to get the most out of the template.

  1. Click the Okay button to exit the screen.

nextSteps

API Network

The Postman API Network provides the most authentic and actionable directory of public APIs available. Every API listed in this network includes a complete Postman collection, created by the API’s publisher. Postman specifically designed the API list to onboard developers quickly and effectively.

On the left side of the screen, Postman groups the APIs categories such as Marketing, Financial Services, E-commerce, and so on. You can search these categories to find an API.

After you select an API from the list, you can import it into your collections.

API_network

To import an API in the API Network:

  1. Click an API in the API Network list. In this example, we’re using the Auth0 API.

API_networkExample

  1. Click the Run In Postman button to import the the API's collection.

You can see the API you imported in the sidebar.

sidebar