Your Private API Network
You can share the APIs that your team uses internally to the Private API Network. Your team can learn about and access these APIs and start using them right away.
- In the top left, select Home.
- In the left navigation bar, select Private API Network to go directly to your team's Private API Network.
To add your API to the network, it must be in the API Builder. You can only add APIs, not collections, to the Private API Network.
Contents
Adding your APIs
You can only add an API to the network if you have edit access to the API, and your team members have permission to view or edit the API. Learn more about roles and permissions.
To add an API to your team's Private API Network from Postman, sign in and select Private API Network in the left navigation bar.
The default view is your team's Private API Network. To add an API to your team's Private API Network, in the left navigation bar, select + Add New.
In the modal, choose the workspace containing the API you want to add to the network. You can select one or more APIs to add to the network at one time. For each API selected, specify the versions to add. Select Next and then the folder to add the APIs to. Select Add to Network.
The APIs that you add to the Private API Network reflect the latest state of the API in your team workspace. In other words, changes made to the API in the workspace will be reflected in the network in real time.
The API will immediately be visible in your team's Private API Network. From the listing, you can edit the network listing or remove the API from the network.
You can also add an API to your team's Private API Network from Postman. Go to the API Builder via APIs in the left navigation bar. Select an API to see a high-level description on the Overview tab. You can Edit Private API Network listing next to the version details on the right.
Security
Private APIs are only visible to logged in users who are a part of your Postman team. They are not discoverable or accessible to anyone who is not a part of your team.
Guidelines
To submit an API to the network, you must have edit access to the API. You cannot add an API to the private network unless all team members have at least view access to the API. Learn more about team roles and permissions.
Folders in Private API Network
You can create new folders from the Private API Network view. Click Add New, then select Folder to create a new folder.
Once you've created the folder, click Add New and select APIs to add APIs to your Team's API Network. You can choose the workspace and then select as many APIs you want to add to the network at one time. For each API selected, specify the versions to add. Click Add.
To edit the API setting, click Edit Network Listing icon.
You can change the versions, update the API summary, and modify the folder to which the API should be added.
You can also remove the added APIs from Postman's API Network. Click the trash icon next to the API you would like to remove from network. Once you click Remove API, your team members will also lose access to the API via the network.
The sidebar navigation displays the folder structure for your Private API Network. You can also drag and drop the APIs and subfolders to different folders.
You can use the search box to search across folders, subfolders, and APIs in your Private API Network. You can also filter the folders, subfolders, and APIs based on name and recently added.
Discovering and consuming private APIs
The Private API Network is a good place to learn about APIs shared within your team. You can browse private APIs in the Private API Network under your team name, or explore public APIs in the public API network.
Private APIs are only visible to logged in users who are a part of your Postman team.
Under your team name, you can browse a directory of APIs shared within your team. Select an API to see a high-level description.
You can review information about the API and the description. Click Open Schema to edit the schema or make changes to the API directly. You can see team collaborators and activities like recently added collections associated with this API.
You can also review version-level details on the right. All available versions are listed below, with an indicator of the active version as well as the versions listed to the network.
Add to Private API Network will display if you haven't added the API to the private network.
