Manage API keys

Postman API key management is available on Postman Enterprise plans.

The Postman API enables you to integrate Postman into your development toolchain, but requires API keys to do so. Team Admins can manage the Postman API keys your team creates at scale, ensuring you maintain compliance and security across your organization. Teams can control the creation of API keys, their expiration dates, and revoke keys when needed.

You must be a Team Admin or Super Admin to use the Postman API key management dashboard.

SCIM API keys can be managed in Team Settings.

Managing Postman API keys

To open the Postman API key management dashboard, select Team > Manage Postman Keys in the Postman header.

Manage Postman keys dashboard

The dashboard lists all of the Postman API keys created by your team. To filter the list by enabled, disabled, or revoked keys, select or clear the checkboxes next to View.

You can review the key's date of creation, its expiration date, who created it, and when it was last used. You can also search by key value to locate a specific key, filter by user by selecting them in the Created by dropdown list, and sort by newest, oldest, and recently used.

Tags next to the API key's name specify when it is disabled or revoked. You can hover over a revoked tag to see if a Team Admin revoked it, if it was due to inactivity past its expiration date, or automatically revoked. Revoked API keys also display their revocation date under its creation date.

Exposed API keys

If the Postman Secret Scanner detects exposed Postman API keys in public Postman workspaces, public Postman documentation, or GitHub and GitLab repositories, the dashboard displays them in the Exposed API keys section. This section provides details about the exposed key, such as the date of its exposure detection, the last time it was used, and the location of the exposed API key.

Exposed keys section

You can manage how Postman automatically handles exposed API keys in the API key settings section of the Postman API key management dashboard.

Revoking API keys

You can revoke an API key in the Postman API key management dashboard by hovering over it and selecting Revoke. To revoke multiple API keys at once, select the checkboxes next to each key, then select Revoke above the list.

Revoke multiple keys

Postman notifies users by email when their API keys are revoked. For exposed keys, revoking also resolves the Secret Scanner finding in the Secret Scanner dashboard.

API key settings

You can manage your team's API key settings and permissions by selecting API Key Settings in the Postman API key management dashboard.

API keys settings

Key generation and expiration

By default, anyone in your team can generate Postman API keys. You can turn off the Allow anyone in your team to generate API keys setting to prevent users from from creating new Postman API keys.

You can set the expiration settings for all API keys that your team creates with the Set expiry for API keys setting. This setting overrides any expiration settings that users previously set. It is also effective moving forward for all of your team's Postman API keys.

Revoking

Enable the Auto revoke exposed Postman API keys setting to allow Postman to automatically revoke any publicly exposed API keys found in publicly accessible Postman resources, GitHub repositories, and Gitlab repositories. When the Postman Secret Scanner detects any exposed keys in public GitHub or GitLab repositories or public Postman resources, it revokes the key and notifies the key's owner by email.

If there are any exposed API keys present when you enable this setting, a warning appears.

Enable auto revoke setting

You can choose to revoke the exposed keys when you enable this setting. You can also choose to ignore them and enable the setting. Any publicly exposed keys detected by the Secret Scanner after you enable this setting will be automatically revoked.

If you need to revoke all of the Postman API keys generated by your team, select Revoke All. Postman notifies users by email when their API keys are revoked.

Last modified: 2024/05/20


Postmanaut dancing. Illustration.