- Installation and updates
- Sending your first request
- Creating the first collection
- Navigating Postman
- Keyboard Shortcuts
- Postman account
- New button
- Troubleshooting In-app Issues
- Customizing Postman
- Find and Replace
- Troubleshooting API requests
- Debugging and logs
- Authorizing requests
- Capturing HTTP requests
- Generate code snippets
- Making SOAP requests
- Working with Tabs
- Using GraphQL
- Visualize API responses
- Intro to collections
- Creating collections
- Sharing collections
- Managing collections
- Requesting access
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Commenting on collections
- Version Control for Collections
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Working with data files
- Running multiple iterations
- Building workflows
- Sharing a collection run
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Documenting your API
- Viewing documentation
- Authoring your documentation
- Publishing your docs
- Custom documentation domains
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Pricing for monitors
- Troubleshooting monitors
- FAQs for monitors
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Introduction to APIs
- Managing APIs
- Sharing APIs and managing roles
- The API Workflow
- Validating Elements Against Schema
- Versioning APIs
- Reporting FAQs
- Viewing and analyzing APIs
- Intro to Workspaces
- Creating Workspaces
- Managing Workspaces
- Using Workspaces
- Sharing collections in Workspaces for version 5
- Viewing changelogs and restoring collections
- What is Postman Pro
- Purchasing Postman Pro
- Upgrading to Postman Pro from a trial team
- Team Settings
- Changing your plan
- Managing your team
- Migrating to Postman v7
- Roles and permissions
- Intro to Enterprise
- Purchasing Postman Enterprise
- Running Postman monitors using static IPs
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Configuring Microsoft AD FS with Postman SSO
- Setting a custom SAML in Azure AD
- Setting up custom SAML in Duo
- Setting up custom SAML in GSuite
- Setting up custom SAML in Okta
- Setting up custom SAML in Onelogin
- Setting up custom SAML in Ping Identity
- Audit logs
- Publishing API documentation
APIs reside in your workspace, just like your collections. This section walks you through how you can create, read, update, and delete APIs in Postman:
- Creating an API
- Opening and viewing an API
- Renaming an API
- Deleting an API
- Removing an API from a workspace
- Commenting on APIs
You can create an API in the workspace from the sidebar in the Postman app and from the workspaces dashboard. To create an API in the Postman app when no APIs exist in the current workspace, click Create an API in the sidebar.
If you already have created APIs in your workspace, click '+' in the sidebar.
Specify a name for your API.
You can create an API only when you are signed in and online.
Alternatively, you can also create an API from your workspace in the web dashboard.
Navigate to the APIs tab and click Create an API.
Specify a name for your API and click the '☑' adjacent to the name. Your API is created.
You can create different API versions from a specific version of your API. For more information on this, refer to the section Creating API versions.
Free users can create up to three APIs, Pro users up to 10, and Enterprise users up to 100.
In the sidebar, click the API you want to open. If there are multiple versions of the API, Postman automatically opens the most recently created.
Using the above interface, you can navigate and view various elements related to an API like mocks, monitors, documentation, and so on.
To rename an API, select the API in the sidebar. On the top right corner, click the ellipsis (...).
Specify a new name and press enter.
You can also rename the versions associated with your APIs. For more information on this, refer to the section Renaming API version tags.
Click the ellipsis (...) next to the API, and select Delete API.
A delete confirmation message appears:
When you delete an API, the collections, monitors, mocks, and environments linked to it are not deleted. For a more detailed understanding on this topic, refer to Sharing APIs
You can also delete specific versions of your APIs. For more information on this, refer to the section Deleting an API version.
From the Postman app, you can remove an API from the sidebar. Click the ellipsis (...) next to the API you would like to remove, select Remove from workspace and confirm that you would like to remove the API from the current workspace. The API will no longer be visible in the workspace.
When you remove an API from a workspace, the collections, monitors, mocks, and environments linked to it are not removed. For a more detailed understanding on this topic, refer to Sharing APIs.
You can also perform these actions from the web dashboard.
You can comment on APIs in the Postman app or web dashboard.
- Comments will be visible in both the dashboard and the app.
- Only those with access to a collection or a request may post comments.
- You can use Markdown in your comments, for more information on formatting using Markdown refer to this Markdown Cheatsheet on Github.
To leave a comment on an API using the Postman Dashboard, navigate to the API tab at the top of the page, select the API on which you want to make a comment and then click Comments at the top-right of the page. Once you have made your comment, click Add comment to publish it.
To leave a comment on an API using the Postman app, select the API on which you want to make a comment and then click Comments at the top-right of the page. Once you have made your comment, click Add comment to publish it.
Sometimes you may want to call the attention of a team member when posting a comment. In such a scenario, you can tag a person by typing the @ symbol followed by the member’s name and then choosing the corresponding name from the auto-suggested list. When you tag a member in your comment, Postman notifies the member by sending a notification.
To edit or delete one of your comments, navigate to the comment section and hover over the comment you wish to manage. Click the pen icon to edit the comment or click on the bin icon to delete the comment.
With Admin permissions you can delete comments made by any contributor, but you cannot update or modify comments.
Postman v7.10 onwards, you can see a changelog for API schemas by clicking on View changelog in the “Design” tab of the API.
The “Schema changelog” pane shows a list of all changes made to the API schema, with the most recent change on top. You can click on each entry to expand and show the entire changeset.
You can also restore the schema to an older changeset by clicking the “Restore” link under each changelog entry. Restoring any changeset other than the most recent one creates a new entry in the changelog. Restoring that change is similar to undoing a merge.
For more information on APIs, see: