Your Private API Network

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.

If you're logged in, go directly to your team's Private API Network. You can always find it by clicking API Network at the top from anywhere in the Dashboard.

In order 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

  • Security
  • Guidelines
• Folders in Private API Network
• Discovering and consuming private APIs
• Next steps

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 your Dashboard, sign in and click API Network at the top.

The default view is your team's Private API Network. Click + Add new.

In the modal, choose the workspace containing the API you want to add to the network. You can select as many APIs to add to the network at one time. For each API selected, specify the version(s) to add. Then click 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 the Postman app. Go to the API Builder via APIs in the left sidebar. Select an API, and see a high-level description on the first tab Overview. You can add and edit your 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 version(s) to add. Click Add.

To edit the API setting, click ... and select Edit network listing.

You can change the versions, update the API summary and even modify the folder to which the API should be added.

You can also remove the added APIs from Postman's API Network. Click ... next to the API you would like to remove, then select 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, recently added, and popularity.

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.

Click through Open in Builder to see a more detailed overview of the API in the web version of the API builder. Under the Overview tab of the API builder, you can review information about the API and update the description. 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. Next to Versions, you can Edit network listing. All available versions are listed below, with an indicator of the active version as well as the version(s) listed to the network. Add to API Network will display if you haven't yet added the API to the private network.

Next steps

• Writing API documentation
• Generating collections from the API