For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API Gateway integrations enable teams to bring APIs into the API Catalog. API specifications then appear in the API Catalog with metadata, including the associated environments and clusters. Collections are automatically generated for further API development in Postman.
The API Catalog supports the following API gateways:
Although discoverable in the Postman integrations marketplace, API gateway apps are only available for connection by customers with Enterprise plans because the API Catalog is an Enterprise-only product. Also, only Team Admins can install apps.
Once the Admin installs the API gateway, all users in the Postman team can select APIs to bring into the Catalog from the Service Discovery tab of the API Catalog.
The following fields are ingested from the gateway:
id
name
version
title
description
openAPI spec
environment
id
name
version
Admins can disconnect the gateway in Organization settings > Installed Apps.
To get started:
Go to the API Catalog and click Service discovery.
Select API Gateway integration as the source.
Select your API gateway from the list of supported gateways.
Enter the data required to connect to your API gateway. The required data depends on the gateway you select. For more information, see the requirements for each gateway below.
Click Install.
Follow the instructions to connect your API gateway to the API Catalog. Once connected, the API Catalog will automatically discover APIs in your gateway and add them to the catalog.
Apigee API Management requirements
To connect to Apigee API Management, you need to have the following:
Project ID — The project ID in your Google Cloud account. Click Service Accounts in the IAM & Admin menu. Select the account and click on the actions menu to reveal, Manage Keys. Create a new key in JSON format. The project ID will be located in this file.
Private key ID — The private key ID in your Google Cloud account. The private key ID is located in the same JSON file created above.
Private key — The private key in your Google Cloud account. The private key is located in the same JSON file created above.
Client email — The client email in your Google Cloud account. The client email is located in the same JSON file created above.
Client ID — The client ID in your Google Cloud account. The client ID is located in the same JSON file created above.
Amazon API Gateway requirements
To connect to Amazon API Gateway, you need to have the following:
Access key — The access key in your AWS account. You can find it in the AWS IAM Console, under IAM > Users, in the Security credentials tab.
Secret key — The secret key in your AWS account. You can find it in the AWS IAM Console, under IAM > Users, in the Security credentials tab.
AWS session token — Find it in the individual values section.
SSO Region — The region where your AWS Gateway is deployed. Find it in the AWS IAM Identity Center credentials section.
Azure API Management requirements
To connect to Azure API Management, you need to have the following:
Client ID — The client ID in your Azure account. You can find it in the Azure Active Directory, under App registrations, in the Overview tab.
Tenant ID — The tenant ID in your Azure account. You can find it in the Azure Active Directory, under App registrations, in the Overview tab.
Client secret — The client secret in your Azure account. You can find it in the Azure Active Directory, under App registrations, in the Certificates & secrets tab.
Subscription ID — The subscription ID in your Azure account. You can find it in the Azure Active Directory, under App registrations, in the Overview tab.
IBM API Connect requirements
To connect to IBM API Connect, you need to have the following:
API key — Click My API Keys in your profile. Create a new API key and copy the API key from the REST API example.
Client ID — Using the same REST API example above, find the Client ID in the curl.
Client secret — Using the same REST API example above, find the Client secret in the curl.