AWS API Gateway

Integrations are available on Postman Team, Business, and Enterprise plans.

You can upload your API schemas directly to AWS API Gateway from Postman with this integration.

This integration uses version 2 of the AWS API and only supports HTTP APIs with OpenAPI 3.0 schemas.

Contents

Uploading API schemas to AWS API Gateway

You can directly upload your API schemas from Postman to AWS API Gateway. Once the integration is configured, any new changes to your schema in Postman will also appear in your AWS API Gateway.

Configuring an AWS API Gateway integration

To add an AWS API Gateway integration, navigate to your Postman Dashboard. Select your desired workspace > Integrations. Click Browse Integrations, locate AWS API Gateway, and select View Details. Click + Add integration.

AWS API Gateway page

Enter your AWS access key ID, secret access key, and region, then click Continue.

Learn how to get your AWS credentials.

Enter access credentials

Select your API, API version, and the API Gateway you'd like to deploy to from the dropdown menus. You can use an existing API Gateway, or create a new one by selecting Create New API Gateway from the dropdown.

If you are creating a new API Gateway, auto-deployment will automatically be set to false in AWS.

Enter API info and Gateway

Your newly created integration will now appear under Configured Integrations.

You can have one AWS API Gateway integration configured for each API version.

Configured integrations

To confirm this integration, navigate to your AWS Gateway dashboard, select your API Gateway, then select Integrations to view your newly uploaded endpoints.

Configured integration in AWS

This integration will be triggered whenever the configured Postman schema is updated. Any configured AWS integrations will be preserved.

Note that if the API or specific API version is deleted, its configured integration will also be deleted.

Next steps

Learn more about other Postman integrations, including custom webhooks and Slack.