Request to add elements to your Private API Network

Your Private API Network is available on Postman Enterprise plans. Requesting to add APIs to your Private API Network requires the API Builder add-on.

Users with the Editor role for a workspace or collection can request to add it to your team's Private API Network. API Network Managers and Folder Managers will review your request and either approve or deny it.

If your team has the API Builder add-on, you can also request to add APIs to your team's Private API Network. API Editors added to the API Builder add-on can request to add their APIs to your team's Private API Network.

Requesting to add elements

To request to add an element to your Private API Network, it must be in a team or public workspace. You can't request to add an element to your Private API Network unless all team members have at least view access to the element. Learn more about team roles and permissions.

When you submit a request, Postman notifies the API Network Manager or Folder Manager who will review your request and either approve or deny it. Postman will notify you of the API Network Manager or Folder Manager's decision. If they deny your request, the notification will include a comment with their reason.

When you add a workspace, collection, or API to your Private API Network, it's visible to your Postman team, but isn't visible to partners.

Requesting to add elements in your Private API Network

Editors of an element can request to add elements from inside your team's Private API Network.

API Editors must be added to the API Builder add-on to request to add APIs. API Network Managers and Folder Managers aren't required to be added to the add-on to review and approve or deny requests.

To request to add elements from your Private API network, do the following:

1. Open your Private API Network.

2. Select Add to Network in the left sidebar to request to add elements to the root Home folder. To request to add elements to a specific folder, select Options > Request to add elements next to a folder.

   You can also select Add on the right of your Private API Network's overview page, or select Add To Folder in the upper-right corner.

3. Search for and then select collections, APIs, and workspaces you want to request to add. You can also filter elements by tags. Learn more about adding tags to collections, APIs, and workspaces.

   If you're requesting to add collections or APIs, you can optionally select environments in their workspace to make sure users have access to environment variables. You can also edit a collection's environments later.

   You can select Added elements in the upper-right corner to show elements already added to your Private API Network. You can select the Collections tab and then Forks in the upper-right corner to show forked collections.

   An API's editor must publish a version of the API before you can add it to your Private API Network.

   You can select an element's name to open it in its workspace in a new tab.

   

4. Select Review.

5. Review your selections, and then select Request to add.

Requesting to add a workspace from the workbench

Workspace Editors can request to add workspaces to your Private API Network from the workbench. API Network Managers and Folder Managers can add a workspace from the workbench.

1. Open the workspace you want to add to your Private API Network.

2. In the workspace overview, select the Settings tab.

3. Select Request to Add.

   

4. (Optional) Select a folder or create one to keep elements organized.

5. (Optional) Select Add comment to add a note for the API Network Manager or Folder Manager.

6. Select Request workspace.

Requesting to add a collection from the workbench

Collection Editors can request to add collections to your Private API Network from the workbench. API Network Managers and Folder Managers can add a collection from the workbench.

1. Open the collection you want to add to your Private API Network.

2. In the collection overview, select Request to Add.

   

3. (Optional) Select Select Environments to make sure users have access to environment variables.

   You can also edit a collection's environments later. To learn more, see Editing collections.

4. (Optional) Select a folder or create one to keep elements organized.

5. (Optional) Select Add comment to add a note for the API Network Manager or Folder Manager.

6. Select Request collection.

Requesting to add an API from the workbench

API Editors can request to add APIs to your Private API Network from the workbench. API Network Managers and Folder Managers can add an API from the workbench.

API Editors must be added to the API Builder add-on to request to add APIs. API Network Managers and Folder Managers aren't required to be added to the add-on to review and approve or deny requests.

An API's editor must publish a version of the API before you can add it to your Private API Network.

1. Open the API you want to add to your Private API Network.

2. In the API overview, select Request to Add.

   

3. (Optional) Select a folder or create one to keep elements organized.

4. (Optional) Select Add comment to add a note for the API Network Manager or Folder Manager.

5. Select Request API.