Share elements on your Postman Private API Network

Your Private API Network is available on Postman Enterprise plans. Adding and managing APIs on your Private API Network requires the API Builder add-on.

Your Private API Network provides a central directory of workspaces, collections, and APIs your team uses internally. Your Postman team can access these resources and start using them right away. By using your team's Private API Network, you can enable developers across your organization to discover, consume, and track API development in one place.

Super Admins and API Network Managers can manage all folders, workspaces, and collections in your Private API Network. Team members can be assigned the Folder Manager role at the folder level, giving them permission to manage specific folders and the workspaces and collections in them.

If your team has the API Builder add-on, your teammates can access APIs on your team's Private API Network. Super Admins, API Network Managers, and Folder Managers added to the API Builder add-on can manage APIs in your Private API Network based on their permission level.

Use your Private API Network

Team members can search for and discover elements, such as workspaces and APIs, in your Private API Network. Your teammates can review details about elements and take actions from them, such as watch and fork a collection.

Workspaces and collections in your team's Private API Network are visible to logged-in users who are on your Postman team. If your team has the API Builder add-on, APIs in your Private API Network are also visible to logged-in users. Users who aren't on your team can't find or access these resources.

Learn more about using your team's Private API Network.

Manage your Private API Network

Super Admins and API Network Managers can add and view requests to add workspaces, collections, and APIs to your team's Private API Network. Users assigned these roles can also organize all elements on your Private API Network into folders. Assign users the Folder Manager role to add, view requests to add, and organize elements in specific folders. To learn more, see Add elements to your Private API Network.

You can manage folders, workspaces, collections, and APIs on your Private API Network. This includes moving and deleting folders and elements from your team's Private API Network. To learn more, see Manage folders and elements in your Private API Network.

Users with the Editor role for a workspace, collection, or API can request to add them to your Private API Network. Learn how to request to add elements to your Private API Network.

You can also use the Postman API to programmatically manage folders and elements in your team's Private API Network

Private API Network reports

You can view a dashboard with metrics about APIs in your team's Private API Network. This dashboard gives you deeper insight into your organization's internal API landscape, including your team's total number of APIs and the number of APIs with documentation.

To view Private API Network reports, select Home from the Postman header, select Reports, then select Content activity > Private Network APIs on the left.

Learn more about the reports in the Private Network APIs dashboard.

Last modified: 2024/09/27