Manage public elements in Postman

The Manage public elements dashboard is available on Postman Enterprise plans.

Public elements in Postman are workspaces, documentation, and collections that you and your team share with the public. Users with a Super Admin or Community Manager role can manage the public visibility of team-owned elements using the Manage public elements dashboard.

Use the dashboard to manage the creation of public workspaces, requests to publish documentation, and creation of collection access keys by team members in your public workspace. You can also delete links to collections you don't want to keep public.

Manage public elements dashboard

Collection access keys allow secure, read-only access to your public workspace collections.

To access the Manage public elements dashboard, select Team in the header, then select Manage Public Elements.

Public workspaces

In the Workspaces tab, you have access to all the public workspaces created by your team. You can also view and respond to requests to make workspaces public.

To respond to a request, hover over the workspace, then select Respond or the workspace name. You'll be taken to the workspace settings, where you can approve or deny the request to convert the workspace to a public workspace.

Convert to public workspaces

To learn more about workspaces, see Create a workspaces in Postman and Manage Postman workspaces. For more details on how to create a public workspace, visit Collaborate with the Postman community using public workspaces.

Public documentation

The Documentation tab displays all the collections with published documentation as well as requests to publish documentation from your team members. To view the documentation set, select the collection name.

To approve or deny a publish request, hover over a request and select Review Request. Select Approve to publish the documentation and make it public, or select Deny to keep the documentation private.

Responding to publish requests

Collection access keys

The Collection Access Keys tab displays your team's collection access keys. You can view which collection a key belongs to, the date of its creation, and who created it. You can find the list of your collection access keys in your API keys page.

If you turn off the Allow creation of Collection Access Keys setting, your team members won't be able to create new collection access keys.

The Collection Access Keys tab

To revoke a key, hover over the key and select Delete.

Select Revoke All Keys to remove all of the team's existing keys.

Revoking a team's keys

Select Revoke All Keys to confirm. To cancel, select Keep All Keys or close the window.

Revoking collection access keys is permanent. You won't be able to undo this action.

Sharing collection JSON files using a public link has been deprecated. No new links can be generated, and existing links can't be modified or edited. Users can still access any existing collection JSON links.

To share a collection in JSON format, you can use the Postman API. To learn more, see Share using the Postman API.

The dashboard's Collection JSON Links tab displays all the collections with existing JSON links.

A Community Manager or Super Admin can view or delete a collection JSON link. In addition to the collection name, the dashboard displays more information about the date the link was updated on, who updated the link, and the JSON link.

Last modified: 2024/08/14